Use your Domino server administrator username and password to log in.
+
+
For Domino REST API installed as part of the installation on a development or test only environment
+
+
Open http://drapi.mymxgo.com/admin/ui or your provided Domino REST API hostname concatenated with /admin/ui in your browser.
+
+
Enter the following credentials in the login page:
+
+
username: mxgo admin
+
password: password
+
+
+
Note
+
If you updated the administrator's first name, last name, and password in the values.yaml file in the Download the Domino REST API Helm chart procedure, use the updated values for the username and password.
+
+
+
+
Click Log in.
+
+
+
Expected result
+
A successful login leads you to the Domino REST API landing page. For details on adding and configuring a schema, adding a scope and an application, see Using Admin UI in the Domino REST API documentation.
This procedure describes how to configure the Rosetta API based on what you need when using the Rosetta formula.
+
+
Register Custom API
+
Preferred API implementation
+
Typeahead Intellisense
+
Converter Configuration
+
Use Native vs API Conversion
+
+
To configure settings in Rosetta API
+
+
+
Click the Project Settings icon.
+
+
+
+
In the Project Setting window, click the Rosetta tab
+
+
Tips
+
When you hover over the info tooltip icon beside each of the label or textbox, you can see the description of each function.
+
+
+
+
+
+
Rosetta area
+
Rosetta area sections
+
Description
+
+
+
+
+
API Configuration
+
+
Allows you to configure options specific to the APIs' implementation and execution.
+
+
+
+
Register Custom API
+
Allows you to upload a file with custom APIs. Refer to the API reference documentation under the rosetta-api module for method registerAPI for more details on expected file format and parameters.
+
+
+
+
Preferred API implementation
+
Allows you to specify whether to execute the Notes Formula or the OpenFormula implementation when calling an API method, which has an existing implementation in either formula language. Example, @Abs() and =ABS() are encapsulated by Rosettas abs() method. Selecting Notes option makes Rosetta call the Notes implementation. Usually, either implementation behaves the same. But in other cases, there may be differences in parameters, execution, or returned results. For example, most Notes formula functions allow lists to be passed in as arguments while OpenFormula allows lists as ranges for only a number of methods. Refer to the API reference documentation for details on each API.
+
+
+
+
Typeahead Intellisense
+
Allows you to include names of formulas that won't be implemented and not yet implemented in the formula list IntelliSense. When no plans to implement items is selected, the names of the formulas that won't be implemented are shown as strikethrough text. If not yet implemented items is selected, the shown names of the formulas not yet implemented are greyed-out.
+
+
+
Converter Configuration
+
+
Allows you to configure options related to how formulas are converted into their corresponding Rosetta-enabled JavaScript.
+
+
+
+
Passthrough unrecognized formula language into JavasSript conversion results
+
Allows you to specify whether the converter allows unrecognized formula code to be part of the javascript conversion results without any massaging, or if it should throw an error when encountering unrecognizable formula code. This allows greater flexibility but also exposes the API to injection of code. Use with care.
+
+
+
+
Use Native vs API Conversion
+
Allows you to specify whether the converter uses native JavaScript or API calls for methods where a native JavaScript function exists. For example, convert @If( ) into JavaScript native if( ) or call the API rosettajs.Logical.if( ). Sometimes, it makes sense and produces cleaner code to select "convert into native JavaScript" than using the API. Other times, you may want to go through the API call itself to allow for additional checks and/or handle the parameters differently.
+
+
+
Version
+
+
Indicates the SDK plugin,API,Converter, and Prettifier versions.
The procedure guides you in connecting to the Domino server from your Notes client. If you installed Domino using the MXGO Domino Helm chart you should configure a Server Connection document to enable connecting to Domino from your Notes client. Follow the steps below.
+
Before you start
+
Make sure that your /etc/hosts file has the preview hostnames. You will need these same entries on any machine you want to connect from, such as your dev laptop. For more information, check the details on adding preview hostnames.
+
Procedure
+
+
Note
+
The procedure is based on using HCL Notes v12.
+
+
+
+
Run the following command to copy the admin.id from the domino-drapi pod:
The $POD_NAME in the command represents the name of the Domino pod. To get the name of the Domino pod, run the command kubectl get pods -n mxgo. In the following example result, the highlighted text corresponds to the Domino pod name.
+
+
So using the example result, the command above should look like:
If necessary, copy the k8s-notes-admin.id file to your laptop.
+
+
+
Switch your ID within the Notes client.
+
+
On your Notes client, select File → Security → Switch ID.
+
+
On the Choose User ID to Switch To dialog, search and select the k8s-notes-admin.id file, and then click Open.
+
+
Note
+
The default password is password.
+
+
+
+
+
+
Specify your names.nsf file within the Notes client.
+
+
On the Notes client, select File → Open → HCL Notes Application.
+
On the Open Application dialog, search and select the names.nsf file, and then click Open.
+
+
+
+
Create a new server connection.
+
+
On the Notes client, select Advanced → New → Server Connection. The Server Connection page opens.
+
On the Basics tab, enter drapi in the Server name text box and then select the TCPIP checkbox for Use LAN port.
+
+
Click the Advanced tab, and then enter drapi.mymxgo.com for your server in the Destination server address text box.
+
+
+
(Optional) If you configured the value of the exposeNRPC parameter to be hostPort during the DRAPI Helm installation, no further configuration is required and you can proceed to Save & Close. If instead you specified nodePort:
+
+
+
Run the following kubectl command to get the port number of the port picked by Kubernetes for the nodePort:
+
kubectl get services domino-drapi-nrpc-external -n mxgo
+
+
The output should be similar to the following:
+
kubectl get services domino-drapi-nrpc-external -n mxgo
+NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S)
+domino-drapi-nrpc-external NodePort 10.43.84.236 <none> 1352:31657/TCP
+
+
+
+
Get the port number from the output and append it to the host name in the Destination server address text box.
+
Using the output example, the PORT(S) column show that port 1352 is being exposed on port 31657. Append :31657 to the host name in the Destination server address text box making a final value of drapi.mymxgo.com:31657.
+
+
+
+
+
Click Save & Close.
+
+
+
+
Note
+
drapi is the abbreviation for Domino REST API.
+
+
+
+
Expected result
+
In your Notes client, you should now be able to select File → Open → HCL Notes Application, specify drapi as the server name, and connect to your new Domino server.
The procedure guides you in configuring Kubernetes Ingress for Domino REST API. Ingress provides and manages external access to the services in your Kubernetes cluster. It's required to enable browsers to access the applications and back-end services to communicate with each other.
+
Before you start
+
Familiarize yourself with the various properties and parameters related to Kubernetes Ingress. Expand the following to learn more:
+
+Kubernetes Ingress details
+
+
+
ingress.enabled: Set to true to enable Ingress. Ingress must be enabled for Domino REST API to function properly. Kindly note that there are certain conditions where you may want to temporarily disable Ingress.
+
+
+
ingress.className: This property sets the class name on the Ingress object. The default is empty string, which enables the processing of Ingress objects by your cluster default Ingress controller. If your cluster does not have a default Ingress controller or if you want to override that, set the class name. Common values you might use include "nginx", "traefik", and "openshift-default". When utilizing Azure Application Gateway in AKS, specify "azure/application-gateway".
+
+
+
ingress.drapiDnsName: The DNS host name that users will use to access the Domino REST API. The default setting is drapi.mymxgo.com.
+
+
+
ingress.drapiManagementDnsName: The DNS host name that administrators will use to access the Domino REST API. The default setting is drapi-management.mymxgo.com.
+
+
+
ingress.protocol: The communication protocol for accessing Volt MX Foundry. Its value can be either http or https. This should reflect the type of traffic you want the Ingress or Load Balancer to accept. If ingress.tls is enabled, this setting must be https.
+
+
+
ingress.tls: Use this property to configure Ingress with either a Cluster or a Custom SSL certificate.
+
+
+
ingress.tls.enabled: Set to true to configure Ingress to use the Cluster SSL Certificate or the specified Custom SSL certificate.
+
+
+
ingress.tls.drapiCustomCert: Use to specify a Custom SSL certificate for Domino REST API. If ingress.tls.drapiCustomCert.cert and ingress.tls.drapiCustomCert.key are not set, the Cluster SSL certificate will be used for TLS.
+
+
+
ingress.tls.drapiCustomCert.cert: The file name for the custom certificate. Place your SSL certificate file in the top level direct drapi directory (where values.yaml is located). The value of this property should be a file path of the form my-drapi-custom-cert.cert where my-drapi-custom-cert.cert is the name of your certificate file. This certificate must be in DER format as per Section 5.1 of RFC 7468.
+
+
+
ingress.tls.drapiCustomCert.key: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form my-drapi-custom-cert.key where my-drapi-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format Section 11 of RFC 7468.
+
+
+
ingress.tls.drapiManagementCustomCert: Use to specify a Custom SSL certificate for Domino REST API. If ingress.tls.drapiCustomCert.cert and ingress.tls.drapiCustomCert.key are not set, then the Cluster SSL certificate will be used for TLS.
+
+
+
ingress.tls.drapiManagementCustomCert.cert: The file name for the custom certificate. Place your SSL certificate file in the top level direct drapi directory (where values.yaml is located). The value of this property should be a file path of the form my-drapi-mgmt-custom-cert.cert where my-drapi-mgmtcustom-cert.cert is the name of your certificate file. This certificate must be in DER format as per Section 5.1 of RFC 7468.
+
+
+
ingress.tls.drapiManagementCustomCert.key: The file name for the custom key. Place your SSL certificate key file in the top level direct 'drapi' directory (where values.yaml is located). The value of this property should be of the form my-drapi-mgmt-custom-cert.key where my-drapi-mgmt-custom-cert.key is the name of your private key file. The key file must be PKCS #8 in DER format Section 11 of RFC 7468.
+
+
+
ingress.annotations: Allows you to specify additional annotations that will be added to every ingress object. Add one annotation per line. Each annotation should be indented 2 spaces and of the format annotationName: value. When rendered, your annotation value will automatically be quoted.
+
+
+
+
Additional information
+
You can configure Kubernetes Ingress to accept connections over HTTP or HTTPS. HTTP isn't secure but works without any extra configuration. It's recommended to use HTTPS for most deployments.
One approach to enable HTTPS is to use a self-signed SSL certificate, which avoids purchasing your own certificate from a Certificate Authority (CA). However, since Foundry makes back-end server to server requests between applications, there are more steps to enable Foundry to trust the secured communication channel when utilizing a self-signed certificate.
+
If you configure your Kubernetes Ingress to use a self-signed SSL certificate or an SSL certificate from your enterprise's own Certificate Authority that's not within a trusted root certification path, or if you use the cluster default cert created from a self-signed CA, you need to add the SSL certificate or CA certificate to the trust store used by Tomcat. Failure to do so results in runtime errors when Foundry components need to communicate with each other. For more information, see Certification Authority Trust Model.
+
Procedure
+
+
Note
+
In general, perform the following procedure before installing Foundry to enable secure HTTPS communication.
+
+
1. Obtain SSL Certificates
+
You can use any of the following options:
+
+
Purchase a certificate from a trusted Certificate Authority
Make sure to replace drapi.example.com with your domain name. You can specify a wild card cert like *.example.com that would enable using a DNS name like drapi.example.com or mydrapi.example.com without changing the certificate. Likewise, do the same for drapi-management.example.com. These commands create new keystores called drapi.keystore and drapi-management.com with a single entry, each containing a new self-signed certificate.
+
+
+
+
Get the private keys from the respective keystores:
The parameter following -connect must be a DNS name or IP address that resolves to your OpenShift ingress. The -servername parameter specifies the DNS name you use to access your foundry deployment. This should match the value you specified for serverDomainName in values.yaml. The DNS names could be the same as long as they resolve to the IP address of your Kubernetes load balancer in front of Ingress or Ingress itself.
2. Copy your SSL certificates and keys into the Domino REST API top level directory
+
+
Tip
+
Helm creates a Kubernetes secret with your SSL certificate details in it for use by Ingress.
+
+
+
+
Copy the SSL certificate and key files into the top level direct drapi directory where values.yaml is located by running the following commands. It's assumed that you will run the commands in the directory where you unzipped the Helm charts.
3. Import certificate into the truststore with keytool
+
+
Important
+
If your SSL certificate is issued by a trusted root CA, you can skip this step.
+
+
+
Use the Java utility keytool to import the certificate by running the following command. It's assumed that you will run the command from the root of the directory where you unzipped the Helm charts.
+
+
# Make foundry aware of the drapi cert:
+keytool-import-aliasdrapi2-file./drapi-server.pem-keypasschangeit-storepasschangeit-keystore../foundry/voltmx-foundry/certs/cacerts
+
+
+
Note
+
+
-alias drapi2 is the alias for the new certificate. You can use any alias but we recommend foundry.
+
-file ./drapi-server.pem is the file path to your certificate. Use the proper path for your circumstances.
+
-keystore ../foundry/voltmx-foundry/certs/cacerts is the location of the truststore your certificate will be imported to and later use by Tomcat. This file path shouldn't be changed.
+
changeit is the default password and shouldn't be changed.
The path for the customCert properties is relative to the apps directory. It should always be certs/ followed by your certificate or key file name.
+
The drapiCustomCert.cert, drapiCustomCert.key, drapiManagementCustomCert.cert, and drapiManagementCustomCert.key details can be omitted when using the default cluster certificate. If you go with this approach, make sure that the DNS hostname which you will access the deployment with matches the host name details in the certificate. Otherwise, the backend communication will fail because the host name doesn't match.
For Volt MX Go Foundry installed as part of the installation on a development or test only environment
+
+
+
Open http://foundry.mymxgo.com/mfconsole/ or your provided Foundry hostname concatenated with /mfconsole/ in your browser. The Welcome to Volt MX Foundry setup page opens.
+
+
Note
+
The Identity Service URL text box is already populated with the Identity Service URL. In case it's empty, enter http://foundry.mymxgo.com/authService or your provided Foundry hostname concatenated with /authService.
+
+
+
+
Under Admin Details:
+
+
Enter your first name in the First Name text box.
+
Enter your last name in the Last Name text box.
+
Enter your email address in the Email text box.
+
Enter your password in the Enter password and Re-enter password text boxes.
+
+
+
+
Click Setup.
+
+
+
+
Expected result
+
Once the details are validated for one-time configuration, the system associates your credentials with Volt MX Foundry identity services and authorization services, and then opens the Sign in to your account page.
This procedure guides you on how to check and set the logging level, and access the log files. For more information, see Logging levels.
+
+
Note
+
The logging level in Volt MX Go Iris only affects the logs for importing a Domino application at the moment.
+
+
Procedure
+
To check the logging level
+
+
+
Go to Help → Logging Level. The current logging level is indicated.
+
+
Note
+
The default level is Trace.
+
+
+
+
To set the logging level
+
+
+
Go to Help → Logging Level, and then choose a logging level based on the level of details you want to find in the logs. To learn the description of each logging level, see Logging levels.
+
+
Note
+
You must restart Volt MX GO Iris after setting a new logging level.
+
+
+
+
To view the logs
+
+
+
From your user directory, go to Iris → irisdata → logs.
+
+
For Windows:
+
+
+
+
For Mac:
+
+
+
+
+
Open the iris_development.log file to view the logs.
The procedure guides you in uninstalling Rancher Desktop in case you want to start over with the installation or you want to completely remove Rancher Desktop.
+
Procedure
+
+
From the taskbar, click the Start menu.
+
Go to Settings → Apps → Apps & features.
+
Find and select the Rancher Desktop entry.
+
Click Uninstall and click it again when the confirmation appears.
+
Follow the prompts on the Rancher Desktop uninstaller to proceed.
The procedure guides you in uninstalling First Touch in case you want to start over with the First Touch installation or you want to completely remove First Touch.
+
Procedure
+
+
+
On the Apps page of the Volt MX Foundry Console, click GET STARTED.
+
OR
+
Select VOLT MX GO First Touch from the side panel.
+
+
+
On the Welcome to Volt MX Go dialog, select Uninstall First Touch Recipes.
+
+
+
+
Click Next. An uninstall progress dialog shows the status of the uninstallation subprocesses.
+
+
Note
+
+
If the Domino REST API configuration can't be pulled from the object service or the object service has been unlinked or deleted, enter your Domino REST API details in the Uninstall First Touch dialog and click Next.
+
If another app is published to the environment created when First Touch was installed, the Progress dialog indicates that the environment isn't deleted as it's used by another app. However, the First Touch app is removed from the environment.
+
+
+
+
+
After the completion of each uninstallation subprocess as indicated by a check icon, click OK to close the dialog.
+
+
+
+
Expected result
+
+
+
The First Touch app and the environment created when installing First Touch are deleted in Volt MX Foundry.
+
+
Note
+
The environment isn't deleted during the uninstallation if another app is published to the environment.
+
+
+
+
The schema, scope, and app related to the First Touch app are deleted from the Domino REST API.
+
+
+
+
Important
+
If you uninstall First Touch and reinstall it again, ensure you clear your browser cache before launching the app.
For the latest release information about Volt MX Go, see What's new.
+
+
How the documentation is organized
+
The Volt MX Go documentation is based on the Diátaxis framework, which organizes documentation into the following modes to address users' documentation needs at different times and in different circumstances. Below shows an overview that guides you on where to look for needed information:
\ No newline at end of file
diff --git a/javadoc/API_context.js.html b/javadoc/API_context.js.html
new file mode 100644
index 00000000..e79c49db
--- /dev/null
+++ b/javadoc/API_context.js.html
@@ -0,0 +1,54 @@
+Source: API_context.js
\ No newline at end of file
diff --git a/javadoc/DDE%20.html b/javadoc/DDE%20.html
new file mode 100644
index 00000000..5e6bf292
--- /dev/null
+++ b/javadoc/DDE%20.html
@@ -0,0 +1,3 @@
+Module: DDE (Dynamic Data Exchange)
Passes the specified command string to the DDE application, which is identified by the conversation ID. @DDEExecute is always used in conjunction with @DDEInitiate and @DDETerminate.
Deposits unsolicited data into the specified location within the DDE server application. If the data was successfully inserted into the target location, @DDEPoke returns an ACK (acknowledgement) with the value @True(1); if the attempt was not successful, the call returns a NACK (negative acknowledgment) with the value @False(0). If the conversation ID is invalid, an error is returned (see @IsError).
\ No newline at end of file
diff --git a/javadoc/ECL%20.html b/javadoc/ECL%20.html
new file mode 100644
index 00000000..d1a0811c
--- /dev/null
+++ b/javadoc/ECL%20.html
@@ -0,0 +1,3 @@
+Module: ECL (Execution Control List)
Displays the administration "Workstation Security: Execution Control List" dialog box for a specified address book and name, which lets you change that administration ECL. Administrators can name Administration ECLs. The name is not usually a user name, but whatever name the administrator chooses; for example, Manager, Developer, or LimitedAccess.
\ No newline at end of file
diff --git a/javadoc/admin.js.html b/javadoc/admin.js.html
new file mode 100644
index 00000000..f8541f7c
--- /dev/null
+++ b/javadoc/admin.js.html
@@ -0,0 +1,303 @@
+Source: admin.js
"use strict";
+/**
+ * @file Administrative
+ * @module admin
+ * @category Administrative
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adminTraceConnection = exports.adminStatisticsConfig = exports.adminSendMailTrace = exports.adminRemoteConsole = exports.adminRegisterUser = exports.adminRegisterServer = exports.adminRegisterFromFile = exports.adminOutgoingMail = exports.adminOpenUsersView = exports.adminOpenStatistics = exports.adminOpenServersView = exports.adminOpenServerLog = exports.adminOpenGroupsView = exports.adminOpenCertLog = exports.adminOpenCatalog = exports.adminOpenAddressBook = exports.adminNewOrgUnit = exports.adminNewOrganization = exports.administration = exports.adminIDFileSetPassword = exports.adminIDFileExamine = exports.adminIDFileClearPassword = exports.adminDatabaseQuotas = exports.adminDatabaseAnalysis = exports.adminCrossCertifyKey = exports.adminCrossCertifyIDFile = exports.adminCreateGroup = exports.adminCertify = exports.adminECLIsLocked = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/admin"));
+exports._notes = notesc;
+/**
+ * Checks the current status of the Administration ECL in the name and address book
+ * and returns 1 (True) if the Administration ECL is locked and editing is
+ * prevented; otherwise returns 0 (False).
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link adminECLIsLocked https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINECLISLOCKED.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function adminECLIsLocked() {
+ return notesc.AdminECLIsLocked();
+}
+exports.adminECLIsLocked = adminECLIsLocked;
+/**
+ * Displays the Choose Certifier ID dialog box, where you can select a Certifier ID
+ * file. After selecting a Certifier ID and entering its password, you select the
+ * user or server ID to be certified.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINCERTIFY.html|www.hcltechsw.com }
+ */
+function adminCertify() {
+ return notesc.AdminCertify();
+}
+exports.adminCertify = adminCertify;
+/**
+ * Opens a Domino® Directory and displays a blank Group form.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINCREATEGROUP.html|www.hcltechsw.com }
+ */
+function adminCreateGroup() {
+ return notesc.AdminCreateGroup();
+}
+exports.adminCreateGroup = adminCreateGroup;
+/**
+ * Displays the Choose Certifier ID dialog box, where you can select a Certifier ID
+ * file. After you select a Certifier ID and enter its password, Notes® displays
+ * the Choose ID to be Cross-Certified dialog box, which allows you to create a
+ * hierarchical cross certificate for an ID in another organization.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINCROSSCERTIFYIDFILE.html|www.hcltechsw.com }
+ */
+function adminCrossCertifyIDFile() {
+ return notesc.AdminCrossCertifyIDFile();
+}
+exports.adminCrossCertifyIDFile = adminCrossCertifyIDFile;
+/**
+ * Displays the Choose Certifier ID dialog box, where you can select a Certifier ID
+ * file. After you select a Certifier ID and enter its password, Notes® displays
+ * the Cross Certify Key dialog box, which allows you to create a cross certificate
+ * for an ID in another organization using the numeric key associated with that ID.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINCROSSCERTIFYKEY.html|www.hcltechsw.com }
+ */
+function adminCrossCertifyKey() {
+ return notesc.AdminCrossCertifyKey();
+}
+exports.adminCrossCertifyKey = adminCrossCertifyKey;
+/**
+ * Displays the Database Analysis dialog box, which provides information about the
+ * selected database on the selected server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINDATABASEANALYSIS.html|www.hcltechsw.com }
+ */
+function adminDatabaseAnalysis() {
+ return notesc.AdminDatabaseAnalysis();
+}
+exports.adminDatabaseAnalysis = adminDatabaseAnalysis;
+/**
+ * For the selected server, displays a list of the databases in which you can
+ * change the size limits.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINDATABASEQUOTAS.html|www.hcltechsw.com }
+ */
+function adminDatabaseQuotas() {
+ return notesc.AdminDatabaseQuotas();
+}
+exports.adminDatabaseQuotas = adminDatabaseQuotas;
+/**
+ * Allows the administrator to delete the password associated with any user ID
+ * file, without having to first switch to that ID and make it active.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINIDFILECLEARPASSWORD.html|www.hcltechsw.com }
+ */
+function adminIDFileClearPassword() {
+ return notesc.AdminIDFileClearPassword();
+}
+exports.adminIDFileClearPassword = adminIDFileClearPassword;
+/**
+ * Displays the Choose ID File to Examine dialog box. After the administrator
+ * selects an ID, Notes/Domino displays the ID Properties box, which contains
+ * information about security basics and your identity.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINIDFILEEXAMINE.html|www.hcltechsw.com }
+ */
+function adminIDFileExamine() {
+ return notesc.AdminIDFileExamine();
+}
+exports.adminIDFileExamine = adminIDFileExamine;
+/**
+ * Allows the administrator to assign a password to any user ID file, without
+ * having to first switch to that ID and make it active.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINIDFILESETPASSWORD.html|www.hcltechsw.com }
+ */
+function adminIDFileSetPassword() {
+ return notesc.AdminIDFileSetPassword();
+}
+exports.adminIDFileSetPassword = adminIDFileSetPassword;
+/**
+ * Opens the Domino® Administrator if the Domino® Administrator package is
+ * installed on the local machine of the user executing the command.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINISTRATION.html|www.hcltechsw.com }
+ */
+function administration() {
+ return notesc.Administration();
+}
+exports.administration = administration;
+/**
+ * Displays the Register Organization Certifier dialog box, where an administrator
+ * can create a hierarchical Certifier ID for an organization. After the
+ * administrator enters a name and password for the new Certifier ID, Notes® asks
+ * the user where to save the ID file and then creates the ID.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINNEWORGANIZATION.html|www.hcltechsw.com }
+ */
+function adminNewOrganization() {
+ return notesc.AdminNewOrganization();
+}
+exports.adminNewOrganization = adminNewOrganization;
+/**
+ * Prompts for the Certifier ID password and then displays the Register
+ * Organizational Unit Certifier dialog box, where the administrator can create a
+ * hierarchical Certifier ID for an organizational unit.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINNEWORGUNIT.html|www.hcltechsw.com }
+ */
+function adminNewOrgUnit() {
+ return notesc.AdminNewOrgUnit();
+}
+exports.adminNewOrgUnit = adminNewOrgUnit;
+/**
+ * Opens a Domino® Directory on the selected server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENADDRESSBOOK.html|www.hcltechsw.com }
+ */
+function adminOpenAddressBook() {
+ return notesc.AdminOpenAddressBook();
+}
+exports.adminOpenAddressBook = adminOpenAddressBook;
+/**
+ * Opens the database catalog (CATALOG.NSF) on the selected server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENCATALOG.html|www.hcltechsw.com }
+ */
+function adminOpenCatalog() {
+ return notesc.AdminOpenCatalog();
+}
+exports.adminOpenCatalog = adminOpenCatalog;
+/**
+ * Opens the certification log (CERTLOG.NSF) on the selected server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENCERTLOG.html|www.hcltechsw.com }
+ */
+function adminOpenCertLog() {
+ return notesc.AdminOpenCertLog();
+}
+exports.adminOpenCertLog = adminOpenCertLog;
+/**
+ * Opens a Domino® Directory on the selected server and displays its Groups view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENGROUPSVIEW.html|www.hcltechsw.com }
+ */
+function adminOpenGroupsView() {
+ return notesc.AdminOpenGroupsView();
+}
+exports.adminOpenGroupsView = adminOpenGroupsView;
+/**
+ * Opens the server log (LOG.NSF) on the selected server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENSERVERLOG.html|www.hcltechsw.com }
+ */
+function adminOpenServerLog() {
+ return notesc.AdminOpenServerLog();
+}
+exports.adminOpenServerLog = adminOpenServerLog;
+/**
+ * Opens a Domino® Directory on the selected server and displays its Servers view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENSERVERSVIEW.html|www.hcltechsw.com }
+ */
+function adminOpenServersView() {
+ return notesc.AdminOpenServersView();
+}
+exports.adminOpenServersView = adminOpenServersView;
+/**
+ * Opens the statistics reporting database (STATREP5.NSF) on the selected server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENSTATISTICS.html|www.hcltechsw.com }
+ */
+function adminOpenStatistics() {
+ return notesc.AdminOpenStatistics();
+}
+exports.adminOpenStatistics = adminOpenStatistics;
+/**
+ * Opens a Domino® Directory on the selected server and displays its People view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOPENUSERSVIEW.html|www.hcltechsw.com }
+ */
+function adminOpenUsersView() {
+ return notesc.AdminOpenUsersView();
+}
+exports.adminOpenUsersView = adminOpenUsersView;
+/**
+ * Displays the contents of the selected server's MAIL.BOX file.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINOUTGOINGMAIL.html|www.hcltechsw.com }
+ */
+function adminOutgoingMail() {
+ return notesc.AdminOutgoingMail();
+}
+exports.adminOutgoingMail = adminOutgoingMail;
+/**
+ * Displays a series of dialog boxes for certifying multiple new users from a text
+ * file.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINREGISTERFROMFILE.html|www.hcltechsw.com }
+ */
+function adminRegisterFromFile() {
+ return notesc.AdminRegisterFromFile();
+}
+exports.adminRegisterFromFile = adminRegisterFromFile;
+/**
+ * Displays a series of dialog boxes for creating a new server ID.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINREGISTERSERVER.html|www.hcltechsw.com }
+ */
+function adminRegisterServer() {
+ return notesc.AdminRegisterServer();
+}
+exports.adminRegisterServer = adminRegisterServer;
+/**
+ * Displays a series of dialog boxes for certifying new users.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINREGISTERUSER.html|www.hcltechsw.com }
+ */
+function adminRegisterUser() {
+ return notesc.AdminRegisterUser();
+}
+exports.adminRegisterUser = adminRegisterUser;
+/**
+ * Displays the Remote Server Console dialog box, where an administrator can enter
+ * server console commands from a workstation.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINREMOTECONSOLE.html|www.hcltechsw.com }
+ */
+function adminRemoteConsole() {
+ return notesc.AdminRemoteConsole();
+}
+exports.adminRemoteConsole = adminRemoteConsole;
+/**
+ * Displays the Mail Path Tracing dialog box, which allows you to send a message to
+ * a location on the mail router and receive a trace message in return.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINSENDMAILTRACE.html|www.hcltechsw.com }
+ */
+function adminSendMailTrace() {
+ return notesc.AdminSendMailTrace();
+}
+exports.adminSendMailTrace = adminSendMailTrace;
+/**
+ * Opens the server events database (EVENTS4.NSF) on the selected server and
+ * displays its Servers to Monitor view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINSTATISTICSCONFIG.html|www.hcltechsw.com }
+ */
+function adminStatisticsConfig() {
+ return notesc.AdminStatisticsConfig();
+}
+exports.adminStatisticsConfig = adminStatisticsConfig;
+/**
+ * Displays the Trace Connections dialog box, which allows you to test network
+ * connections through a passthru server.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADMINTRACECONNECTION.html|www.hcltechsw.com }
+ */
+function adminTraceConnection() {
+ return notesc.AdminTraceConnection();
+}
+exports.adminTraceConnection = adminTraceConnection;
+//# sourceMappingURL=admin.js.map
\ No newline at end of file
diff --git a/javadoc/agent.js.html b/javadoc/agent.js.html
new file mode 100644
index 00000000..587e8a63
--- /dev/null
+++ b/javadoc/agent.js.html
@@ -0,0 +1,111 @@
+Source: agent.js
"use strict";
+/**
+ * @file Agents (Domino)
+ * @module agent
+ * @category Agents
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.agentTestRun = exports.agentSetServerName = exports.agentLog = exports.agentEdit = exports.runScheduledAgents = exports.runAgent = exports.isAgentEnabled = exports.agentEnableDisable = exports.agentRun = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/agent"));
+exports._notes = notesc;
+/**
+ * Runs the currently selected agent and then displays its log.
+ * @param {Array} ...args any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AGENTRUN.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function agentRun() {
+ return notesc.AgentRun();
+}
+exports.agentRun = agentRun;
+/**
+ * Enables or disables the specified agent.
+ * @param {Array} ...args any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AGENTENABLEDISABLE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function agentEnableDisable() {
+ return notesc.AgentEnableDisable();
+}
+exports.agentEnableDisable = agentEnableDisable;
+/**
+ * Indicates whether or not a scheduled agent is enabled.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISAGENTENABLED.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isAgentEnabled() {
+ return notesc.IsAgentEnabled();
+}
+exports.isAgentEnabled = isAgentEnabled;
+/**
+ * Executes a specified agent.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_RUNAGENT_COMMAND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function runAgent() {
+ return notesc.RunAgent();
+}
+exports.runAgent = runAgent;
+/**
+ * Runs all of the database's scheduled agents, regardless of when they are
+ * scheduled to run. The agents will then run as usual at their regularly scheduled
+ * times.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_RUNSCHEDULEDAGENTS_COMMAND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function runScheduledAgents() {
+ return notesc.RunScheduledAgents();
+}
+exports.runScheduledAgents = runScheduledAgents;
+/**
+ * Opens the Agent Properties box for the currently selected agent.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AGENTEDIT.html|www.hcltechsw.com }
+ */
+function agentEdit() {
+ return notesc.AgentEdit();
+}
+exports.agentEdit = agentEdit;
+/**
+ * Displays the log for the currently selected agent. The log contains information
+ * about when the agent last ran, what actions it performed, and when it finished
+ * running.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AGENTLOG.html|www.hcltechsw.com }
+ */
+function agentLog() {
+ return notesc.AgentLog();
+}
+exports.agentLog = agentLog;
+/**
+ * Specifies a scheduled agent to run on a particular server.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AGENTSETSERVERNAME.html|www.hcltechsw.com }
+ */
+function agentSetServerName() {
+ return notesc.AgentSetServerName();
+}
+exports.agentSetServerName = agentSetServerName;
+/**
+ * Displays a log for the currently selected agent, describing what actions the
+ * agent will perform when run.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AGENTTESTRUN.html|www.hcltechsw.com }
+ */
+function agentTestRun() {
+ return notesc.AgentTestRun();
+}
+exports.agentTestRun = agentTestRun;
+//# sourceMappingURL=agent.js.map
\ No newline at end of file
diff --git a/javadoc/attachment.js.html b/javadoc/attachment.js.html
new file mode 100644
index 00000000..59c26f9f
--- /dev/null
+++ b/javadoc/attachment.js.html
@@ -0,0 +1,61 @@
+Source: attachment.js
"use strict";
+/**
+ * @file Attachments
+ * @module attachment
+ * @category Attachments
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attachmentView = exports.attachmentProperties = exports.attachmentLaunch = exports.attachmentDetachAll = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/attachment"));
+exports._notes = notesc;
+//-----------------------------
+// Notes @Commands attachments
+/**
+ * Displays the Save Attachments To dialog box, where you select a location for the
+ * current document's attachments.
+ * @param {Array} ...args any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTDETACHALL.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function attachmentDetachAll() {
+ return notesc.AttachmentDetachAll();
+}
+exports.attachmentDetachAll = attachmentDetachAll;
+/**
+ * Launches the selected attachment by opening the application in which it was
+ * created, if possible.
+ * @param {Array} ...args any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTLAUNCH.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function attachmentLaunch() {
+ return notesc.AttachmentLaunch();
+}
+exports.attachmentLaunch = attachmentLaunch;
+/**
+ * Displays the Properties box for the current attachment.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTPROPERTIES.html|www.hcltechsw.com }
+ */
+function attachmentProperties() {
+ return notesc.AttachmentProperties();
+}
+exports.attachmentProperties = attachmentProperties;
+/**
+ * Launches the Attachment Viewer, which lets you view the contents of the selected
+ * attachment without opening the application in which it was created.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTVIEW.html|www.hcltechsw.com }
+ */
+function attachmentView() {
+ return notesc.AttachmentView();
+}
+exports.attachmentView = attachmentView;
+//# sourceMappingURL=attachment.js.map
\ No newline at end of file
diff --git a/javadoc/compatibility.js.html b/javadoc/compatibility.js.html
new file mode 100644
index 00000000..ada6c4c9
--- /dev/null
+++ b/javadoc/compatibility.js.html
@@ -0,0 +1,90 @@
+Source: compatibility.js
\ No newline at end of file
diff --git a/javadoc/create.js.html b/javadoc/create.js.html
new file mode 100644
index 00000000..b04db02f
--- /dev/null
+++ b/javadoc/create.js.html
@@ -0,0 +1,222 @@
+Source: create.js
"use strict";
+/**
+ * @file Create
+ * @module create
+ * @category Create
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createView = exports.createTextbox = exports.createSubform = exports.createSection = exports.createRectangularHotspot = exports.createRectangle = exports.createPolyline = exports.createPolygon = exports.createNavigator = exports.createLayoutRegion = exports.createForm = exports.createFolder = exports.createEllipse = exports.createControlledAccessSection = exports.createAgent = exports.createAction = exports.composeWithReference = exports.compose = exports._notes_vmx = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc_base = tslib_1.__importStar(require("../notes/create"));
+const notesc_vmx = tslib_1.__importStar(require("../notes/voltmx/create"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const notesc = () => API.isDefaultFrameworkVoltMX() ? notesc_vmx : notesc_base;
+exports._notes = notesc_base;
+exports._notes_vmx = notesc_vmx;
+//-----------------------------
+// Notes @Commands create
+/**
+ * Creates a new, blank document.
+ * @param {any} serverDatabase
+ * @param {string} form
+ * @returns {boolean}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_COMPOSE.html|www.hcltechsw.com }
+ */
+function compose(serverDatabase, form) {
+ return notesc().Compose(serverDatabase, form);
+}
+exports.compose = compose;
+/**
+ * Creates a new document filling in the Body rich text field with values based on the current document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_COMPOSEWITHREFERENCE.html|www.hcltechsw.com }
+ */
+function composeWithReference() {
+ return notesc().ComposeWithReference();
+}
+exports.composeWithReference = composeWithReference;
+/**
+ * Creates a new action and opens the design pane, where you can edit the action.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEACTION.html|www.hcltechsw.com }
+ */
+function createAction() {
+ return notesc().CreateAction();
+}
+exports.createAction = createAction;
+/**
+ * Creates a new agent in the current database and opens the Agent Properties box,
+ * where you can name and define the agent.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEAGENT.html|www.hcltechsw.com }
+ */
+function createAgent() {
+ return notesc().CreateAgent();
+}
+exports.createAgent = createAgent;
+/**
+ * Creates a controlled access section on a form or subform. Unlike a regular
+ * section, a controlled access section has a formula to determine who can edit it.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATECONTROLLEDACCESSSECTION.html|www.hcltechsw.com }
+ */
+function createControlledAccessSection() {
+ return notesc().CreateControlledAccessSection();
+}
+exports.createControlledAccessSection = createControlledAccessSection;
+/**
+ * Lets you create an ellipse in a navigator. After you invoke the command, the
+ * cursor changes to a crosshair when you start to drag the mouse in the design
+ * area. You create an ellipse by dragging the mouse until the ellipse is the size
+ * you want.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEELLIPSE.html|www.hcltechsw.com }
+ */
+function createEllipse() {
+ return notesc().CreateEllipse();
+}
+exports.createEllipse = createEllipse;
+/**
+ * Displays the Create Folder dialog box, which lets you choose a location for a
+ * new folder and create it.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEFOLDER.html|www.hcltechsw.com }
+ */
+function createFolder() {
+ return notesc().CreateFolder();
+}
+exports.createFolder = createFolder;
+/**
+ * Creates a new, blank form in a database.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEFORM.html|www.hcltechsw.com }
+ */
+function createForm() {
+ return notesc().CreateForm();
+}
+exports.createForm = createForm;
+/**
+ * Creates a new layout region on a form or subform.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATELAYOUTREGION.html|www.hcltechsw.com }
+ */
+function createLayoutRegion() {
+ return notesc().CreateLayoutRegion();
+}
+exports.createLayoutRegion = createLayoutRegion;
+/**
+ * Creates a new, blank navigator in a database.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATENAVIGATOR.html|www.hcltechsw.com }
+ */
+function createNavigator() {
+ return notesc().CreateNavigator();
+}
+exports.createNavigator = createNavigator;
+/**
+ * Lets you create a polygon in a navigator. After you invoke the command, the
+ * cursor changes to a crosshair when you start to drag the mouse in the design
+ * area. You create a polygon by clicking the mouse each time you want to start
+ * a new side. Double-click when you are done.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEPOLYGON.html|www.hcltechsw.com }
+ */
+function createPolygon() {
+ return notesc().CreatePolygon();
+}
+exports.createPolygon = createPolygon;
+/**
+ * Lets you create a polyline in a navigator. After you invoke the command, the
+ * cursor changes to a crosshair when you start to drag the mouse in the design
+ * area. You create a polyline by clicking the mouse each time you want to start
+ * a new line. Double-click when you are done.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEPOLYLINE.html|www.hcltechsw.com }
+ */
+function createPolyline() {
+ return notesc().CreatePolyline();
+}
+exports.createPolyline = createPolyline;
+/**
+ * Lets you create a rectangle in a navigator. After you invoke the command, the
+ * cursor changes to a crosshair when you start to drag the mouse in the design
+ * area. You create a rectangle by dragging the mouse until the rectangle is the
+ * size you want.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATERECTANGLE.html|www.hcltechsw.com }
+ */
+function createRectangle() {
+ return notesc().CreateRectangle();
+}
+exports.createRectangle = createRectangle;
+/**
+ * Lets you create a rectangular hotspot in a navigator. After you invoke the
+ * command, the cursor changes to a crosshair when you start to drag the mouse in
+ * the design area. You create a rectangular hotspot by dragging the mouse until
+ * the rectangle is the size you want.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATERECTANGULARHOTSPOT.html|www.hcltechsw.com }
+ */
+function createRectangularHotspot() {
+ return notesc().CreateRectangularHotspot();
+}
+exports.createRectangularHotspot = createRectangularHotspot;
+/**
+ * Creates a section.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATESECTION.html|www.hcltechsw.com }
+ */
+function createSection() {
+ return notesc().CreateSection();
+}
+exports.createSection = createSection;
+/**
+ * Creates a new, blank subform in a database.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATESUBFORM.html|www.hcltechsw.com }
+ */
+function createSubform() {
+ return notesc().CreateSubform();
+}
+exports.createSubform = createSubform;
+/**
+ * Lets you create a textbox in a navigator. After you invoke the command, the
+ * cursor changes to a crosshair when you start to drag the mouse in the design
+ * area. You create a textbox by dragging the mouse until the textbox is the size
+ * you want.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATETEXTBOX.html|www.hcltechsw.com }
+ */
+function createTextbox() {
+ return notesc().CreateTextbox();
+}
+exports.createTextbox = createTextbox;
+/**
+ * Displays the Create View dialog box, which lets you choose a location for a new
+ * view and create it.
+ * @param {Array} ...args any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CREATEVIEW.html|www.hcltechsw.com }
+ */
+function createView() {
+ return notesc().CreateView();
+}
+exports.createView = createView;
+//# sourceMappingURL=create.js.map
\ No newline at end of file
diff --git a/javadoc/data/search.json b/javadoc/data/search.json
new file mode 100644
index 00000000..40ab3c0c
--- /dev/null
+++ b/javadoc/data/search.json
@@ -0,0 +1 @@
+{"list":[{"title":"DDE (Dynamic Data Exchange)","link":"DDE (Dynamic Data Exchange)","description":"
dde
"},{"title":"DDE (Dynamic Data Exchange)~ddeExecute","link":"ddeExecute","description":"
Passes the specified command string to the DDE application, which is identified\nby the conversation ID. @DDEExecute is always used in conjunction with\n@DDEInitiate and @DDETerminate.
"},{"title":"DDE (Dynamic Data Exchange)~ddeInitiate","link":"ddeInitiate","description":"
Initiates a conversation with a DDE server, and returns the conversation ID.
"},{"title":"DDE (Dynamic Data Exchange)~ddePoke","link":"ddePoke","description":"
Deposits unsolicited data into the specified location within the DDE server\napplication. If the data was successfully inserted into the target location,\n@DDEPoke returns an ACK (acknowledgement) with the value @True(1); if the\nattempt was not successful, the call returns a NACK (negative acknowledgment)\nwith the value @False(0). If the conversation ID is invalid, an error is\nreturned (see @IsError).
"},{"title":"DDE (Dynamic Data Exchange)~ddeTerminate","link":"ddeTerminate","description":"
Terminates the conversation with a DDE application.
"},{"title":"ECL (Execution Control List)~editECL","link":"editECL","description":"
Displays the administration "Workstation Security: Execution Control List"\ndialog box for a specified address book and name, which lets you change that\nadministration ECL. Administrators can name Administration ECLs. The name is not\nusually a user name, but whatever name the administrator chooses; for example,\nManager, Developer, or LimitedAccess.
"},{"title":"ECL (Execution Control List)~editUserECL","link":"editUserECL","description":"
Displays the "Workstation Security: Execution Control List" dialog box, which\nallows you to change your personal ECL for the current workstation.
"},{"title":"ECL (Execution Control List)~refreshECL","link":"refreshECL","description":"
Copies the administration execution control list from a specified Address Book\nand name to your personal workstation ECL.
Displays the Choose Certifier ID dialog box, where you can select a Certifier ID\nfile. After selecting a Certifier ID and entering its password, you select the\nuser or server ID to be certified.
Displays the Choose Certifier ID dialog box, where you can select a Certifier ID\nfile. After you select a Certifier ID and enter its password, Notes® displays\nthe Choose ID to be Cross-Certified dialog box, which allows you to create a\nhierarchical cross certificate for an ID in another organization.
Displays the Choose Certifier ID dialog box, where you can select a Certifier ID\nfile. After you select a Certifier ID and enter its password, Notes® displays\nthe Cross Certify Key dialog box, which allows you to create a cross certificate\nfor an ID in another organization using the numeric key associated with that ID.
Checks the current status of the Administration ECL in the name and address book\nand returns 1 (True) if the Administration ECL is locked and editing is\nprevented; otherwise returns 0 (False).
Displays the Choose ID File to Examine dialog box. After the administrator\nselects an ID, Notes/Domino displays the ID Properties box, which contains\ninformation about security basics and your identity.
Displays the Register Organization Certifier dialog box, where an administrator\ncan create a hierarchical Certifier ID for an organization. After the\nadministrator enters a name and password for the new Certifier ID, Notes® asks\nthe user where to save the ID file and then creates the ID.
Prompts for the Certifier ID password and then displays the Register\nOrganizational Unit Certifier dialog box, where the administrator can create a\nhierarchical Certifier ID for an organizational unit.
Displays the log for the currently selected agent. The log contains information\nabout when the agent last ran, what actions it performed, and when it finished\nrunning.
Runs all of the database's scheduled agents, regardless of when they are\nscheduled to run. The agents will then run as usual at their regularly scheduled\ntimes.
Creates a controlled access section on a form or subform. Unlike a regular\nsection, a controlled access section has a formula to determine who can edit it.
Lets you create an ellipse in a navigator. After you invoke the command, the\ncursor changes to a crosshair when you start to drag the mouse in the design\narea. You create an ellipse by dragging the mouse until the ellipse is the size\nyou want.
Lets you create a polygon in a navigator. After you invoke the command, the\ncursor changes to a crosshair when you start to drag the mouse in the design\narea. You create a polygon by clicking the mouse each time you want to start\na new side. Double-click when you are done.
Lets you create a polyline in a navigator. After you invoke the command, the\ncursor changes to a crosshair when you start to drag the mouse in the design\narea. You create a polyline by clicking the mouse each time you want to start\na new line. Double-click when you are done.
Lets you create a rectangle in a navigator. After you invoke the command, the\ncursor changes to a crosshair when you start to drag the mouse in the design\narea. You create a rectangle by dragging the mouse until the rectangle is the\nsize you want.
Lets you create a rectangular hotspot in a navigator. After you invoke the\ncommand, the cursor changes to a crosshair when you start to drag the mouse in\nthe design area. You create a rectangular hotspot by dragging the mouse until\nthe rectangle is the size you want.
Lets you create a textbox in a navigator. After you invoke the command, the\ncursor changes to a crosshair when you start to drag the mouse in the design\narea. You create a textbox by dragging the mouse until the textbox is the size\nyou want.
Given the name of a database as a text string, returns a text string containing\nthe DB2® schema of that database if it is a db2nsf database or the empty string\nif it is not a db2nsf database.
Returns a list of users, groups, and servers who currently have Manager access\nto the database. In a window title formula, only the name of the first manager\nlisted in the ACL is displayed.
\n
@DbManager does not work in selection formulas or column formulas.
In a column or window title formula, returns the number of child documents or\ncategories belonging to the current document or category. Only immediate\nresponses count as children. For example, the responses to a main document are\nits children, but the responses to a response document are not.
In a column or window title formula, returns the number of descendant documents\nor subcategories belonging to the current document or category. Where\n@DocChildren only counts direct descendants, @DocDescendants counts all\ndescendants, regardless of level.
In a column or window title formula, returns a string representing the entry\nnumber of the current document or category. For example, 2.3 indicates that the\ndocument is the third entry following the second entry.
In a column or window title formula, returns a string that represents the entry\nnumber of the parent view entry. Both the current view entry and the parent can\nbe either documents or categories.
In a column or window title formula, returns a string that represents the total\nnumber of entries at the same level as a view entry (document or category). The\nreturned total includes the document itself. For example, if the document is\nentry 8.2, and entries 8.1, 8.3, and 8.4 also exist, then there are four\ndocument siblings
For a particular database on the user's workspace, RenameDatabase locates a\nreplica of that database (based on its replica ID) on the specified server, and\nreplaces the database icon with that of the replica. The only change the user\nsees is that the server name has changed on the database icon.
Switches to the specified view or folder within the current database or, if a\nview or folder is not specified, displays the View menu so the user can select\na view.
Adjusts the specified time-date value by the number of years, months, days, hours, minutes, and/or seconds you specify.\nThe amount of adjustment may be positive or negative.
Constructs the date from year, month, and day of month or translates numbers for the various components of time and date,\nthen returns the time-date value.
Constructs and returns a Date object from one of the following combination of time-date parameters:\n( hour, minute, second ), ( year, month, day, hour, minute, second ),\nor Date object or array of Date objects, as per the notes formula Time function parameters.
Converts a date to a number representing where the week falls numerically with a year.
\n
There are two systems used for this function:
\n
\n
System 1 The week containing January 1 is the first week of the year, and is numbered week 1.
\n
System 2 The week containing the first Thursday of the year is the first week of the year,\nand is numbered as week 1. This system is the methodology specified in ISO 8601,\nwhich is commonly known as the European week numbering system.
Return the string representation of the date before or after a specified number of\nworkdays using parameters to indicate which and how many days are weekend days.
Displays the Design Form Formula dialog box, where the user can define a formula\nthat determines which form is used to display documents opened from a particular\nview or folder.
Displays the design pane and sets the Define control to View Selection, which\nallows you to define a selection formula to determine which documents are\ndisplayed in a view.
In a Service Provider (xSP) environment, returns the name of the subdirectory\nfor the company with which the currently authenticated user is registered. Notes/\nDomino retrieves this information from the organization's certifier document.
Returns a number or a number list containing the length of each attachment to\nthe current document. The number(s) returned are only approximations; the actual\nsize(s) of the attachment(s) may be slightly different.
Returns a datetime that displays the date on which the file attachment\nassociated with the current document was last modified. If the document contains\nmore than one file attachment, returns the modification dates in a datetime list.
Returns the operating system file names of any files attached to a document. If\nthere are multiple files attached, the names are returned as a multiple-value\ntext list.
Returns the approximate number of bytes a truncated document lost during\nreplication. The bytes are the total number of bytes per attachment, OLE object,\nlarge rich text field, or non-summary items that were too large, according to\nthe replication settings for the database, to be replicated.
The universal ID, which uniquely identifies a document across all replicas of a\ndatabase. In text format, the universal ID is a 32-character combination of\nhexadecimal digits (0-9, A-F).
\n
The universal ID is also known as the unique ID or UNID.
In an agent that runs a formula, @HardDeleteDocument permanently removes the\ndocument currently being processed from the database if the database has soft\ndeletions enabled. If the database does not have soft deletions enabled,\n@HardDeleteDocument performs the same action as @DeleteDocument.
A view you specify from which the user can select one or more documents.\n@pickList returns a column value from the selected document(s).
\n
A dialog box, displaying information from all available Domino® Directories.\nThe user can select one or more person, group, server, room, or resource names,\nand @pickList returns those names.
Assigns a value to a field stored within a document (use @set for temporary\nvariables). This is similar to using the FIELD keyword, except that @setField\ncan be used within another @function. If the field does not exist, this\ncommand creates it and applies the specified value to it.
Displays the Properties box for the currently selected Notes® object. For\nexample, if a document is selected in a view, displays the document Properties\nbox; if a field is selected on a form, displays the field Properties box.
Moves the insertion point in a document down by the number of lines you specify.\nIf you don't specify a number, moves the insertion point down one line.
Performs the menu command Edit - Find/Replace without moving the focus to the\nediting window. This allows searches to take place when the focus is on the view\nor folder panes.
Indents a paragraph 1/4 inch. The entire paragraph is indented, as well as any\nparagraphs that are subsequently typed below it, until the user disables\nindenting.
Indents the first line of a paragraph 1/4 inch. The first line of the current\nparagraph is indented, as well as first lines of subsequently typed paragraphs,\nuntil the user disables indenting. (A carriage return defines a new paragraph.)
Creates a new button and displays the design pane, where the user can define a\nformula, simple action(s), LotusScript®, or JavaScript™ for the button.
Moves the insertion point in a document, form, subform, or page to the left by\nthe number of spaces you specify. If you don't specify a number, moves the\ninsertion point one space to the left.
Makes selected text look like an Internet-style reply by prefixing each line\nwith a greater-than sign and removing attachments and other objects. This sets\neach line of the message to a default length, preventing it from wrapping in\nunexpected places when sent to non-Notes users.
Displays the proportions of the selected graphic at the end of the screen. The\nuser can size the picture by dragging the mouse in the appropriate direction.
Moves the insertion point in a document to the right by the number of spaces you\nspecify. If you don't specify a number, moves the insertion point one space to\nthe right.
Displays the Select by Date dialog box, where the user indicates which documents\nshould be selected in the view or folder, according to the date they were\ncreated or last modified.
Closes the current Notes® window. If the document or design element in that\nwindow has not been saved, Notes® prompts the user to save it before closing.
Opens the specified database to the specified view, highlighting the first\ndocument whose value in the sort column matches the key. You specify a database\nusing its server and file name.
Opens the specified database to the specified view, highlighting the first\ndocument whose value in the sort column matches the key. You specify a database\nusing its replica ID, and Notes/Domino searches the workspace and all servers\navailable in the current session to find a replica.
Displays the Page Setup dialog box (or, on the Macintosh, the File Print Margins\ndialog box), which allows you to specify print settings for the selected\ndatabase.
Executes a Notes/Domino command. Most of the standard menu commands can be\nexecuted using @Command. In addition, a number of specialized commands are\navailable. In a formula, any command invoked using @Command runs in the\norder you specify in the formula. This means that any changes made by the\ncommand, such as inserting text into a field, affect the rest of the formula\n(see exceptions).
\n
In the context of RosettaJS, the @Command is a Notes @Formula function that\ndoes not exist in the functions of the Notes @Formula language but rather an
At run-time, compiles and runs each element in a text expression as a formula.\nReturns the result of the last formula expression in the list or an error if an\nerror is generated by any of the formula expressions in the list.
Updates the context of a formula to the Notes® client window currently being\naccessed by the code. For example, if the code accesses a new form called\n"Response" by using @Command([Compose]:"Response", @UpdateFormulaContext\nswitches the context of the formula to this new form. Any subsequent functions in\nthe code execute in the context of the Response document, not the current document.
Displays the About This Database or database policy document for the current\ndatabase (which typically explains the purpose of the application, as well as\nits intended audience).
Displays the Using This Database document for the current database. The Using\nThis Database document typically provides pointers on how to use an\napplication's forms and views.
Returns the URL and port number of the LDAP listener in the current domain.\nNotes® looks for this information in several places, following this search\nsequence:
\n\n
Searches on the current server.
\n
Searches for the notes.ini variable labeled LDAPSERVER=.
\n
Queries the administration server, which runs the LDAP service automatically, by default.
Allows you to generate an error condition within an expression. This is useful\nif you want to evaluate the current values in several fields and need to know if\nan error has occurred in the entry of any of them.
Calculates the number of text, number, or time-date values in a list. This\nfunction always returns a number to indicate the number of entries in the list.
\n
This function is similar to @Elements, except that it returns the number 1\ninstead of 0, when the value it is evaluating is not a list or is a null string.
Calculates the number of text, number, or time-date values in a list. This\nfunction always returns a number to indicate the number of entries in the list.
Returns the value that appears in the number position. If the number is greater\nthan the number of values, @Select returns the last value in the list. If\nthe value in the number position is a list, returns the entire list contained\nwithin the value.
Searches a list from beginning to end and returns the number values you specify.\nIf you specify a negative number, @Subset searches the list from end to\nbeginning, but the result is ordered as from the beginning of the list.
Without a parameter, returns a random, unique text value. With a parameter,\nremoves duplicate values from a text list by returning only the first occurrence\nof each member of the list.
Executes one or more statements iteratively while a condition remains true.\nExecutes an initialization statement. Checks the condition before executing the\nstatements and executes an increment statement after executing the statements.
Tests for a null value. Returns true only if a value is a single text value that\nis null, otherwise it returns false. This function also returns false if the\nvalue is an error.
Immediately stops the execution of a formula and returns the specified value.\nThis is useful when you only want the remainder of the formula to be executed\nonly if certain conditions are True.
Evaluates an expression against a list of values and returns the result corresponding to the first matching value.\nIf there is no match, an optional default value may be returned.
Creates and displays a blank mail document. Notes/Domino uses the default form\nfor the user's mail database. This is a Memo document unless the user has\nchanged it.
Displays the Choose ID to be Cross-Certified dialog box, which allows an\nadministrator to send a safe copy of a Certifier ID to another administrator,\nwho can certify it with a different Certifier ID to create a cross certificate.
Displays the Change User Name dialog box, which allows the user to send a\nportion of the Notes® user ID to a Notes/Domino administrator, who can change\nthe user name associated with the ID and return the ID to the user. The user\nthen merges the updated portion back into the existing user ID.
Displays the Mail New Public Key Request dialog box, which allows the user to\nsend a portion of his or her Notes/Domino ID to an administrator, who can create\na new public key for the ID and return the ID to the user. The user then merges\nthe updated portion back into the existing user ID.
Displays the Mail Certificate Request dialog box. This lets the user send a safe\ncopy of the Notes/Domino user ID to an administrator, who certifies and then\nreturns it; the user then merges the updated safe copy back into the user ID.
Displays the User ID dialog box, where the user can define and send encryption\nkeys. If the user's ID is password-protected, the user will be required to\nenter the password before being allowed access to the dialog box.
Displays the Mail Public Key dialog box. This lets the user send the public key\nto another user (typically to an administrator who can then paste the public key\ninto that user's Person record in the Domino® Directory).
Given an angle in radians, returns the cosine of the angle. In a right triangle,\nthe cosine of an acute angle is the ratio of the length of its adjacent side to\nthe length of the hypotenuse.
Given an angle in radians, returns the sine of the angle. In a right triangle,\nthe sine of an acute angle is the ratio of the length of its opposite side to\nthe length of the hypotenuse.
Given an angle in radians, returns the tangent of the angle. In a right triangle\nthe tangent of an acute angle is the ratio of the length of the opposite side to\nthe length of the adjacent side.
Puts Designer into debug mode, so that all LotusScript® scripts run in the\ndebugger. The command is a toggle; selecting it again takes Notes® out of debug\nmode.
Brings up a dialog box that displays the current document (either open or\nselected in a view). The dialog box shares fields with the underlying document.\nThe user interacts with the dialog box as usual, clicking OK or Cancel when\nfinished.
\n
This function can be used with any form, but it's particularly useful with forms\nthat contain a single table or layout region, because the user can interact with\nthe table or layout region as if it were a dialog box.
Displays the Directories dialog box which allows you to search for an address,\nview detailed information about an address entry, and add an entry to your\nDomino® Directory with the Directories dialog box.
When used with no parameters, @MailSend mails the current document (the one\nbeing processed when the @function is evaluated) to the recipient designated\nin the document's SendTo field. The document must have a SendTo field.
\n
When used with one or more parameters, @MailSend composes a new mail memo\nbased on the information you supply in the arguments list, and sends it to the\nrecipients listed in the sendTo, copyTo, and blindcopyTo arguments.
In Standard Outline views, filters a view to display only documents from a\nspecified category. In Calendar views, filters a view to display only documents\nthat contain a specified string in a specified column.
Cycles through the list of styles that have been defined for the current\ndocument, form, or page. This is the same as pressing F11. Each time you invoke\nStyleCycleKey, a different style goes into effect.
Opens a navigator in Testing mode, so you can test its hotspots, formulas, and\nscripts. Selecting this command again puts the navigator back into Design mode.
Opens a frameset defined for the current database. Framesets provide a way for\ndesigners to display several pages at the same time. A frame is actually one\npage; a frameset is a collection of pages. Page designers can create links\nbetween frames. A major advantage of framesets is the ability to leave one page\nconstant as users scroll or link to other pages.
Allows you to create your own context-sensitive help documents. To use this\ncommand, you must first create a view that has a sorted first column containing\nkey values that uniquely identify each help document. @Command([OpenHelpDocument])\nsearches this sorted view for the specified key value and, if found, displays\nthe associated help document in a separate Help window.
Opens a page defined for the current database. A page is a design element that\nstructures and displays information, including text, graphics, applets, and\nlinks. Unlike a form, a page cannot contain fields, subforms, layout regions,\nand some embedded controls.
This formula sends the values entered in the dialog box to the parent document.\nA designer can update a parent note and close the dialog box without having to\nuse the OK button on the dialog box.
Register an API by adding it as an object to the referential array of APIs\nDefines/redefines the Rosetta API library by creating/updating a node in the API object\nThe API object may be redefined if when using the existing category, name, language combination\nIf language param is supplied, the API node will also define the method at the formula language level and\nthe main method will point to call the method inside the language object
Tests a string for a pattern string. Because the pattern string can contain a\nnumber of "wildcard" characters and logical symbols, you can test for complex\ncharacter patterns.
Returns any substring from the middle of a string. The middle is found by\nscanning the string from left to right, and parameters determine where the\nmiddle begins and ends.
Returns any substring from the middle of a string. The middle is found by\nscanning the string from right to left, and parameters determine where the middle\nbegins and ends.
Converts full-pitch alphanumeric characters (double byte characters -- DBCS) in\nthe specified string to half-pitch alphanumeric characters (single byte\ncharacters -- SBCS). This function works in Japanese, Korean, Simplified Chinese,\nand traditional Chinese environments. In the Japanese environment, this function\ncan convert full-pitch Katakana as well.
Returns the rightmost characters in the string. You can specify the number of\nrightmost characters you want returned, or you can indicate that you want all\nthe characters following a specific substring.
Converts half-pitch alphanumeric characters (single-byte characters -- SBCS) in\nthe specified string to full-pitch alphanumeric characters (double-byte\ncharacters -- DBCS). This function works in Japanese, Korean, Simplified\nChinese, and traditional Chinese environments. In the Japanese environment, this\nfunction can convert half-pitch Katakana as well.
Returns the specified word from a text string. A "word" is defined as the part\nof a string that is delimited by the defined separator character. For example,\nif you specify a space (" ") as the separator, then a word is any series of\ncharacters preceded by and followed by a space (or the beginning or end of the\nstring).
Displays the Replicate dialog box, where the user can choose to replicate the\ncurrent database using the options defined in Replicator or using special\none-time options.
Runs all of the database's scheduled agents, regardless of when they are\nscheduled to run. The agents will then run as usual at their regularly scheduled\ntimes.
Opens the current location document in your Personal Address Book in Edit mode,\nallowing you to change your home server, mail database location, and time zone.
Displays the Mail section of the User Preferences dialog box, where the user can\nindicate how often Notes® should check for new mail, whether to sign and encrypt\noutgoing mail, and so on.
Returns specific Hypertext Transfer Protocol (HTTP) header information from the\nUniform Resource Locator (URL). A URL is a text string used for identifying and\naddressing a Web page.
Used for navigating, saving, and reloading a Uniform Resource Locator (URL)\nhistory list. The URL history list keeps track of all the Web pages you have\nvisited. The history list is used for the Next and Previous buttons and for the\nWeb Tours.
Allows you to manipulate hierarchical names. You can abbreviate the canonical\nformat of a name, expand an abbreviated name to its canonical format, identify\nparticular components within the name, and reverse the order of the components\nso that you can categorize a view by hierarchical names.
\n
Enables you to convert a name between the Domino® and LDAP formats.
If the user name is hierarchical, @UserName returns it in canonical format\n(including the CN, OU, O, and C identifiers). To return the name in abbreviated\nformat (omitting those identifiers), use @V3UserName.
For a database on a server or a local database with "Enforce a consistent Access\nControl List across all replicas" in effect, @UserNamesList returns a text\nlist containing the following information for the current user:
\n
\n
Common name
\n
All hierarchical names (fully distinguished) that include the user name; for\nexample, CN=My Name/OU=My Org Unit/O=My Org, plus \t*/OU=My Org\nUnit/O=My Org, */O=My Org, and *
\n
Any roles associated with the user in the ACL
\n
All groups to which the user belongs (only if the database is on a server)
Returns a text list of the current user's privileges. This function returns only\nthe position of the privilege in the privilege list, not the name of the\nprivilege.
For a database on a server or a local replicated database, returns a list of\nroles that the current user has. Roles are defined in a database's access control\nlist.
Returns the current user name or server name. Using @V3UserName on a local\ndatabase or in a private view in a server-based database returns the user's name.
\n
If the user name is hierarchical, @V3UserName returns the name in\nabbreviated format (omitting the CN, OU, O, and C identifiers). To return the\nname in canonical format, use @UserName.
Displays the Certificates section of the User ID dialog box. If the user ID is\npassword-protected, the user must enter the password before displaying the\ndialog box.
Displays the Enter Safe Copy ID File Name dialog box, where the user defines a\nfile name for storing a safe copy of the Notes/Domino user ID. The safe copy\ncontains only the user name and public key. The private key and all certificates\nare omitted from the safe copy.
Displays the Encryption section of the User ID dialog box. If the user ID is\npassword-protected, the user must enter the password before displaying the\ndialog box.
Displays the Choose User ID to Merge into Current® ID dialog box. This lets the\nuser select an updated user ID (for example, one that has been certified by an\nadministrator) and merge it into the existing user ID (thus retaining the\ninformation already stored in the existing ID). If the user ID is\npassword-protected, Notes/Domino requires the user to enter the password before\ndisplaying the dialog box.
Displays the Set Password dialog box where the user can enter a new password for\nthe Notes/Domino ID. If a password already exists, the user must enter the\nexisting password before specifying a new one.
Displays the Choose User ID to Switch To dialog box. If the selected ID is\npassword-protected, Notes/Domino next displays the Enter Password dialog box,\nwhere the user must enter the correct password.
Switches to the specified view or folder within the current database or, if a\nview or folder is not specified, displays the View menu so the user can select\na view.
Collapses all levels of subcategories, documents, and responses within the\ncurrent category, so only the first category name shows. If the view or folder\nhas a response hierarchy but is not categorized, ViewCollapse collapses all\nlevels of response documents under the current main document.
Collapses all levels of categories, subcategories, documents, and responses\nwithin a view or folder so that only the first level of category names appears.\nIf the view or folder has a response hierarchy but is not categorized,\nViewCollapseAll collapses all levels of response documents under the main\ndocuments.
Expands one level of subcategories, documents, and responses within the current\ncategory. If the view or folder has a response hierarchy but is not categorized,\nViewExpand expands all levels of response documents under the current main\ndocument.
Displays the Certify Selected Entries dialog box, which enables you to upgrade\nthe selected user name to a hierarchical name, change the user's common name, or\nchange the user's hierarchical name.
Shows field Help, so that the Help description for the current field (if\navailable) appears on the status bar while the user composes or edits a\ndocument. (Field Help is a design option specified in the Field Properties box.)\nThis command is a toggle; selecting it a second time hides the field Help.
Displays the "object delimiter" -- a dotted frame surrounding an OLE/LEL object\nwithin a field. This command is a toggle; selecting it a second time hides the\nobject delimiter so the OLE/LEL object looks like regular, editable data.
Collapses the view or folder so that only category and subcategory names show up.\nThis command is a toggle; selecting it a second time expands all category levels.
Shows the results of a full-text search as selected documents in a view or\nfolder. This command is a toggle. Instead of listing only the documents that\nsatisfy the search query (the default for a full-text search), the view or\nfolder lists all the documents it normally lists, with a check mark in front\nof those documents that satisfy the search query.
Displays only the selected documents or categories in the view or folder (those\ndocuments with a check mark). This command is a toggle; selecting it a second\ntime displays all documents or categories.
Displays a line representing each page break in the document. The page breaks\nindicate where Notes® will end each page when the document is printed on the\ncurrently selected printer. This command is a toggle; selecting it a second time\nsuppresses the display of automatic page breaks (manual page breaks will still\nbe displayed).
Toggles the display of the full-text search bar at the beginning of the view. If\nthe database does not have a full-text index, the search bar displays but is not\nusable.
Gets the current API context (if ctx param is null or not supplied) or\nSets the API context to either database for local DOM, for those APIs\nthat require working with differents contexts such as GetField/SetField
Uses the console object's methods to display Debug messages,\nprepending them with a timestamp. Defaults to console.log() if\nno type of logger is supplied
Same as the File - Close command menu. Closes the current Notes® tab, or the\nwindow if this was the last tab in the window. If the document or design element\nin that window has not been saved, Notes® prompts the user to save it before\nclosing.
Resizes all open Notes/Domino windows to less than 50% of their maximum window\nsize and layers them in a cascading stack. Because the layered stack is cascaded,\nthe title bar of each window is visible behind the stack's first window. To\ndisplay a window that is lower in the stack, you can make it first by clicking\nits title bar.
Maximizes all open Notes/Domino windows. Notes/Domino windows include the\nDesigner and Administration client windows as well as any of the Notes® Help\nwindows.
Minimizes all open Notes/Domino windows. Notes/Domino windows include the\nDesigner and Administration client windows as well as any of the Notes® Help\nwindows.
Maximizes the Notes® window whose taskbar button follows the current window's\ntaskbar button or, if the windows are cascaded, moves the next window in the\nstack to the beginning of the stack.
Resizes all open Notes/Domino windows to display them all at once. The open\nwindows are tiled across the screen until they fill the background. If two\nwindows are currently open, Notes® displays them side-by-side. If four windows\nare open, Notes® displays one in each of the four quadrants of the window.
For databases on the workspace that are replicas of one another, stacks them\ninto a single icon. The command is a toggle; selecting it a second time unstacks\nthe replica icons and displays each icon individually.
"}]}
\ No newline at end of file
diff --git a/javadoc/database.js.html b/javadoc/database.js.html
new file mode 100644
index 00000000..3d278a22
--- /dev/null
+++ b/javadoc/database.js.html
@@ -0,0 +1,582 @@
+Source: database.js
"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.switchView = exports.renameDatabase = exports.publishDatabase = exports.databaseReplSettings = exports.databaseDelete = exports.addDatabaseRepID = exports.addDatabase = exports.webDbName = exports.viewTitle = exports.setProfileField = exports.serverName = exports.replicaID = exports.isExpandable = exports.isDB2 = exports.getProfileField = exports.dbTitle = exports.dbName = exports.dbManager = exports.dbExists = exports.dbCommand = exports.dB2Schema = exports.setDocField = exports.selectDocuments = exports.isCategory = exports.getDocField = exports.docSiblings = exports.docParentNumber = exports.docNumber = exports.docLevel = exports.docDescendants = exports.docChildren = exports.dbLookup = exports.dbColumn = exports.dVarP = exports.dVar = exports.dSum = exports.dstDevP = exports.dstDev = exports.dProduct = exports.dMin = exports.dMax = exports.dGet = exports.dCountA = exports.dCount = exports.dAverage = exports.findField = exports._openFormula = exports._notes_vmx_utils = exports._notes_vmx = exports._notes = void 0;
+const tslib_1 = require("tslib");
+/**
+ * @file Database
+ * @module database
+ * @category Database
+ */
+const openf = tslib_1.__importStar(require("../openformula/database"));
+const notesf_base = tslib_1.__importStar(require("../notes/database"));
+const notesf_vmx = tslib_1.__importStar(require("../notes/voltmx/database"));
+const notesf_vmx_utils = tslib_1.__importStar(require("../notes/voltmx/database.utils"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const notesf = () => API.isDefaultFrameworkVoltMX() ? notesf_vmx : notesf_base;
+const notesc = notesf; // notes commands are exposed in the notes functions source file; this notesc is just for visual cue
+exports._notes = notesf_base;
+exports._notes_vmx = notesf_vmx;
+exports._notes_vmx_utils = notesf_vmx_utils;
+exports._openFormula = openf;
+//-----------------------------
+// Open Formula database
+/**
+ *
+ * Not listed as a public database function in OpenFormula help
+ *
+ * @param {Array} database
+ * @param {string} title
+ * @returns (TBD)
+ */
+function findField(database, title) {
+ return openf.FINDFIELD(database, title);
+}
+exports.findField = findField;
+/**
+ * Finds the average of values in a given field from the records (rows) in a
+ * database that match a search criteria.
+ * @param {Array} database Range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
+ * @param {string} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
+ * @param {Array} criteria Range of values that contains the conditions you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
+ * @returns {number} Average of the field's values from call to OpenFormula DAVERAGE function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DAVERAGE|www.oasis-open.org}
+ */
+function dAverage(database, field, criteria) {
+ return openf.DAVERAGE(database, field, criteria);
+}
+exports.dAverage = dAverage;
+/**
+ * Counts the number of records (rows) in a database that match a search criteria
+ * and contain numerical values.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Count of records matching search criteria from call to OpenFormula
+ * DCOUNT function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DCOUNT|www.oasis-open.org}
+ */
+function dCount(database, field, criteria) {
+ return openf.DCOUNT(database, field, criteria);
+}
+exports.dCount = dCount;
+/**
+ * Counts the number of records (rows) in a database that match a search criteria
+ * and contain values (as COUNTA).
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Count of records matching search criteria from call to OpenFormula
+ * DCOUNTA function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DCOUNTA|www.oasis-open.org}
+ */
+function dCountA(database, field, criteria) {
+ return openf.DCOUNTA(database, field, criteria);
+}
+exports.dCountA = dCountA;
+/**
+ * Get the single value in the field from the single record (row) in a database
+ * that matches a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Value in field matching search criteria from call to OpenFormula DGET function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DGET|www.oasis-open.org}
+ */
+function dGet(database, field, criteria) {
+ return openf.DGET(database, field, criteria);
+}
+exports.dGet = dGet;
+/**
+ * Finds the maximum value in a given field from the records (rows) in a database
+ * that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Maximum value of the field's values matching search criteria from call
+ * to OpenFormula DMAX function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DMAX|www.oasis-open.org}
+ */
+function dMax(database, field, criteria) {
+ return openf.DMAX(database, field, criteria);
+}
+exports.dMax = dMax;
+/**
+ * Finds the minimum value in a given field from the records (rows) in a database
+ * that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Minimum value of the field's values matching search criteria from call
+ * to OpenFormula DMIN function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DMIN|www.oasis-open.org}
+ */
+function dMin(database, field, criteria) {
+ return openf.DMIN(database, field, criteria);
+}
+exports.dMin = dMin;
+/**
+ * Finds the product of values in a given field from the records (rows) in a
+ * database that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Product of the field's values matching search criteriain field records
+ * matching search criteria from call to OpenFormula DPRODUCT function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DPRODUCT|www.oasis-open.org}
+ */
+function dProduct(database, field, criteria) {
+ return openf.DPRODUCT(database, field, criteria);
+}
+exports.dProduct = dProduct;
+/**
+ * Finds the sample standard deviation in a given field from the records (rows) in
+ * a database that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Sample standard deviation of the field's values matching search criteria
+ * from call to OpenFormula DSTDEV function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DSTDEV|www.oasis-open.org}
+ */
+function dstDev(database, field, criteria) {
+ return openf.DSTDEV(database, field, criteria);
+}
+exports.dstDev = dstDev;
+/**
+ * Finds the population standard deviation in a given field from the records (rows)
+ * in a database that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Population standard deviation of the field's values matching search
+ * criteria from call to OpenFormula DSTDEVP function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DSTDEVP|www.oasis-open.org}
+ */
+function dstDevP(database, field, criteria) {
+ return openf.DSTDEVP(database, field, criteria);
+}
+exports.dstDevP = dstDevP;
+/**
+ * Finds the sum of values in a given field from the records (rows) in a database
+ * that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Sum of the field's values matching search criteria from call to
+ * OpenFormula DSUM function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DSUM|www.oasis-open.org}
+ */
+function dSum(database, field, criteria) {
+ return openf.DSUM(database, field, criteria);
+}
+exports.dSum = dSum;
+/**
+ * Finds the sample variance in a given field from the records (rows) in a database
+ * that match a search criteria.
+ * @param {Array} catabase The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Sample variance of the field's values matching search criteria from call
+ * to OpenFormula DVAR function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DVAR|www.oasis-open.org}
+ */
+function dVar(database, field, criteria) {
+ return openf.DVAR(database, field, criteria);
+}
+exports.dVar = dVar;
+/**
+ * Finds the population variance in a given field from the records (rows) in a
+ * database that match a search criteria.
+ * @param {Array} database The database
+ * @param {string} field The field
+ * @param {Array} criteria The criteria
+ * @returns {number} Population variance of the field's values matching search criteria from
+ * call to OpenFormula DVARP function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DVARP|www.oasis-open.org}
+ */
+function dVarP(database, field, criteria) {
+ return openf.DVARP(database, field, criteria);
+}
+exports.dVarP = dVarP;
+//-----------------------------
+// Notes @functions database
+/**
+ * Returns a column of values from a view or folder in a Domino® database.
+ * @param {*} cache
+ * @param {any} serverDatabase
+ * @param {string} viewName
+ * @param {number} column
+ * @returns Promise
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DBCOLUMN_NOTES_DATABASES.html|www.hcltechsw.com }
+ */
+const dbColumn = (cache, serverDatabase, viewName, column = 1) => {
+ return notesf().DbColumn(cache, serverDatabase, viewName, column);
+};
+exports.dbColumn = dbColumn;
+/**
+ * Given a key value, looks in the specified view (or folder) and finds all
+ * documents containing the key value within the view.
+ * @param {*} cache
+ * @param {any} serverDatabase
+ * @param {string} viewName
+ * @param {string} key
+ * @param {any} field
+ * @returns Promise
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DBLOOKUP_NOTES_DATABASES.html|www.hcltechsw.com }
+ */
+const dbLookup = (cache, serverDatabase, viewName, key, field, keywords) => {
+ return notesf().DbLookup(cache, serverDatabase, viewName, key, field, keywords);
+};
+exports.dbLookup = dbLookup;
+/**
+ * In a column or window title formula, returns the number of child documents or
+ * categories belonging to the current document or category. Only immediate
+ * responses count as children. For example, the responses to a main document are
+ * its children, but the responses to a response document are not.
+ * @param {Array} any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCCHILDREN.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docChildren() {
+ return notesf().DocChildren();
+}
+exports.docChildren = docChildren;
+/**
+ * In a column or window title formula, returns the number of descendant documents
+ * or subcategories belonging to the current document or category. Where
+ * @DocChildren only counts direct descendants, @DocDescendants counts all
+ * descendants, regardless of level.
+ * @param {Array} any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCDESCENDANTS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docDescendants() {
+ return notesf().DocDescendants();
+}
+exports.docDescendants = docDescendants;
+/**
+ * Returns a text string that represents the level of the document or category.
+ * @param {Array} any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCLEVEL.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docLevel() {
+ return notesf().DocLevel();
+}
+exports.docLevel = docLevel;
+/**
+ * In a column or window title formula, returns a string representing the entry
+ * number of the current document or category. For example, 2.3 indicates that the
+ * document is the third entry following the second entry.
+ * @param {Array} any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCNUMBER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docNumber() {
+ return notesf().DocNumber();
+}
+exports.docNumber = docNumber;
+/**
+ * In a column or window title formula, returns a string that represents the entry
+ * number of the parent view entry. Both the current view entry and the parent can
+ * be either documents or categories.
+ * @param {Array} any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCPARENTNUMBER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docParentNumber() {
+ return notesf().DocParentNumber();
+}
+exports.docParentNumber = docParentNumber;
+/**
+ * In a column or window title formula, returns a string that represents the total
+ * number of entries at the same level as a view entry (document or category). The
+ * returned total includes the document itself. For example, if the document is
+ * entry 8.2, and entries 8.1, 8.3, and 8.4 also exist, then there are four
+ * document siblings
+ * @param {Array} any arguments
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCSIBLINGS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docSiblings() {
+ return notesf().DocSiblings();
+}
+exports.docSiblings = docSiblings;
+/**
+ * Given the unique ID of a document, returns the contents of a specific field on
+ * that document. The document must reside in the current database.
+ * @param {string} documentUNID
+ * @param {string} fieldName
+ * @returns {any} fieldValue
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_GETDOCFIELD.html|www.hcltechsw.com }
+ */
+function getDocField(documentUNID, fieldName) {
+ return notesf().GetDocField(documentUNID, fieldName);
+}
+exports.getDocField = getDocField;
+/**
+ * In a column formula, returns a specified string if any item in the row of a view
+ * is defined as a category.
+ * @returns {string}
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISCATEGORY.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isCategory() {
+ return notesf().IsCategory();
+}
+exports.isCategory = isCategory;
+/**
+ * Returns a Promise that can be resolved to an array of selected documents.
+ * @param {string} formula
+ * @returns {*} Promise
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SELECT.html|www.hcltechsw.com }
+ */
+const selectDocuments = (formula) => {
+ return notesf().SelectDocuments(formula);
+};
+exports.selectDocuments = selectDocuments;
+/**
+ * Given the unique ID of a document, sets the value of a specific field on that
+ * document. The document must reside in the current database.
+ * @param {string} documentUNID The unique ID of a document.
+ * @param {string} fieldName The name of a field in the current document.
+ * @param {any} fieldValue The value to set the field.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETDOCFIELD.html|www.hcltechsw.com }
+ */
+function setDocField(documentUNID, fieldName, fieldValue) {
+ return notesf().SetDocField(documentUNID, fieldName, fieldValue);
+}
+exports.setDocField = setDocField;
+/**
+ * Given the name of a database as a text string, returns a text string containing
+ * the DB2® schema of that database if it is a db2nsf database or the empty string
+ * if it is not a db2nsf database.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DB2SCHEMA.html|www.hcltechsw.com }
+ */
+function dB2Schema() {
+ return notesf().DB2Schema();
+}
+exports.dB2Schema = dB2Schema;
+/**
+ * Accesses view and folder information from a Domino® database in Web applications.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DBCOMMAND_DOMINO_DATA_SOURCE_.html|www.hcltechsw.com }
+ */
+function dbCommand() {
+ return notesf().DbCommand();
+}
+exports.dbCommand = dbCommand;
+/**
+ * Given a server and file name, or replica ID, indicates whether the specified
+ * database exists.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOESDBEXIST.html|www.hcltechsw.com }
+ */
+function dbExists() {
+ return notesf().DbExists();
+}
+exports.dbExists = dbExists;
+/**
+ * Returns a list of users, groups, and servers who currently have Manager access
+ * to the database. In a window title formula, only the name of the first manager
+ * listed in the ACL is displayed.
+ *
+ * @DbManager does not work in selection formulas or column formulas.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DBMANAGER.html|www.hcltechsw.com }
+ */
+function dbManager() {
+ return notesf().DbManager();
+}
+exports.dbManager = dbManager;
+/**
+ * Returns the name of the current Domino® server and database.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DBNAME.html|www.hcltechsw.com }
+ */
+function dbName() {
+ return notesf().DbName();
+}
+exports.dbName = dbName;
+/**
+ * Returns the title of the current database.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DBTITLE.html|www.hcltechsw.com }
+ */
+function dbTitle() {
+ return notesf().DbTitle();
+}
+exports.dbTitle = dbTitle;
+/**
+ * Retrieves a field from a profile document, and caches the field value for the
+ * remainder of the session.
+ * @param {Array} any arguments
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_GETPROFILEFIELD.html|www.hcltechsw.com }
+ */
+function getProfileField() {
+ return notesf().GetProfileField();
+}
+exports.getProfileField = getProfileField;
+/**
+ * Given a server and filename or server and replica ID, indicates if the specified
+ * database is backed by DB2® or not.
+ * @returns {boolean}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDB2.html|www.hcltechsw.com }
+ */
+function isDB2() {
+ return notesf().IsDB2();
+}
+exports.isDB2 = isDB2;
+/**
+ * In column formulas, returns a specified string if a row in a view can be
+ * expanded.
+ * @returns {string}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISEXPANDABLE.html|www.hcltechsw.com }
+ */
+function isExpandable() {
+ return notesf().IsExpandable();
+}
+exports.isExpandable = isExpandable;
+/**
+ * Returns the replica ID of the current database.
+ * @returns {string}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REPLICAID_FUNCTION.html|www.hcltechsw.com }
+ */
+function replicaID() {
+ return notesf().ReplicaID();
+}
+exports.replicaID = replicaID;
+/**
+ * Returns the name of the server containing the current database. When the
+ * database is local, returns the user name.
+ * @returns {string}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SERVERNAME_FUNCTION.html|www.hcltechsw.com }
+ */
+function serverName() {
+ return notesf().ServerName();
+}
+exports.serverName = serverName;
+/**
+ * Sets the value of a field in a profile document or creates a profile document.
+ * @returns {*}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETPROFILEFIELD.html|www.hcltechsw.com }
+ */
+function setProfileField() {
+ return notesf().SetProfileField();
+}
+exports.setProfileField = setProfileField;
+/**
+ * Returns the current view's name. If there are aliases and synonyms, they are
+ * returned in a text list.
+ * @returns {string|string[]}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_VIEWTITLE.html|www.hcltechsw.com }
+ */
+function viewTitle() {
+ return notesf().ViewTitle();
+}
+exports.viewTitle = viewTitle;
+/**
+ * Returns the name of the current database encoded for URL inclusion.
+ * @returns {string}
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_WEBDBNAME.html|www.hcltechsw.com }
+ */
+function webDbName() {
+ return notesf().WebDbName();
+}
+exports.webDbName = webDbName;
+/**
+ * Adds the specified database icon to the user's workspace, without opening the
+ * database.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADDDATABASE.html|www.hcltechsw.com }
+ */
+function addDatabase() {
+ return notesc().AddDatabase();
+}
+exports.addDatabase = addDatabase;
+/**
+ * Adds an icon to the desktop for the database specified by its replica ID.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADDDATABASEREPID.html|www.hcltechsw.com }
+ */
+function addDatabaseRepID() {
+ return notesc().AddDatabaseRepID();
+}
+exports.addDatabaseRepID = addDatabaseRepID;
+/**
+ * Permanently deletes the current database file from the hard disk where it is
+ * stored.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DATABASEDELETE_COMMAND.html|www.hcltechsw.com }
+ */
+function databaseDelete() {
+ return notesc().DatabaseDelete();
+}
+exports.databaseDelete = databaseDelete;
+/**
+ * Displays the Replication Settings dialog box for the current database.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DATABASEREPLSETTINGS.html|www.hcltechsw.com }
+ */
+function databaseReplSettings() {
+ return notesc().DatabaseReplSettings();
+}
+exports.databaseReplSettings = databaseReplSettings;
+/**
+ * Displays the Publish Database dialog box, where the user selects a library in
+ * which to publish the selected database.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PUBLISHDATABASE.html|www.hcltechsw.com }
+ */
+function publishDatabase() {
+ return notesc().PublishDatabase();
+}
+exports.publishDatabase = publishDatabase;
+/**
+ * For a particular database on the user's workspace, RenameDatabase locates a
+ * replica of that database (based on its replica ID) on the specified server, and
+ * replaces the database icon with that of the replica. The only change the user
+ * sees is that the server name has changed on the database icon.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_RENAMEDATABASE.html|www.hcltechsw.com }
+ */
+function renameDatabase() {
+ return notesc().RenameDatabase();
+}
+exports.renameDatabase = renameDatabase;
+/**
+ * Switches to the specified view or folder within the current database or, if a
+ * view or folder is not specified, displays the View menu so the user can select
+ * a view.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SWITCHVIEW_COMMAND.html|www.hcltechsw.com }
+ */
+function switchView() {
+ return notesc().SwitchView();
+}
+exports.switchView = switchView;
+//# sourceMappingURL=database.js.map
\ No newline at end of file
diff --git a/javadoc/date-time.js.html b/javadoc/date-time.js.html
new file mode 100644
index 00000000..c8bd19eb
--- /dev/null
+++ b/javadoc/date-time.js.html
@@ -0,0 +1,900 @@
+Source: date-time.js
"use strict";
+/**
+ * @file Date & Time
+ * @module date-time
+ * @category Date & Time
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.accessed = exports.locale = exports.getCurrentTimeZone = exports.zone = exports.yesterday = exports.tomorrow = exports.timeMerge = exports.modified = exports.created = exports.businessDays = exports.adjust = exports.yearFrac = exports.workDayIntl = exports.workDay = exports.weekNum = exports.timeValue = exports.netWorkDaysIntl = exports.netWorkDays = exports.isoWeekNum = exports.interval = exports.eoMonth = exports.eDate = exports.days360 = exports.days = exports.dateValue = exports.dateDif = exports.year = exports.weekday = exports.today = exports.time = exports.second = exports.now = exports.month = exports.minute = exports.hour = exports.day = exports.date = exports._notes = exports._openFormula = void 0;
+const tslib_1 = require("tslib");
+const openf = tslib_1.__importStar(require("../openformula/date-time"));
+exports._openFormula = openf;
+const openf_compat = tslib_1.__importStar(require("../openformula/compatibility"));
+const notesf = tslib_1.__importStar(require("../notes/date-time"));
+exports._notes = notesf;
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const common_1 = require("../utils/common");
+const error = tslib_1.__importStar(require("../utils/error"));
+//-----------------------------
+// Rosetta date-time - common functions (exist in both OpenFormula and Notes Formula)
+/**
+ * Constructs the date from year, month, and day of month or translates numbers for the various components of time and date,
+ * then returns the time-date value.
+ *
+ * @param {number|Date|Date[]} yearOrDateTime The year that you want to appear in the resulting date.
+ * You must specify an entire four-digit year. (For example, use 1996, not 96).
+ * Or Time-date or time-date list. For a time-date value such as @Now or [10/31/93 12:00:00], @Date removes the time portion of the value, leaving only the date.
+ * @param {number} month Optional (when DateTime provided). The month that you want to appear in the resulting date. (For example, use 1 to specify January).
+ * @param {number} day Optional (when DateTime provided). The day that you want to appear in the resulting date.
+ * @param {number} hour Optional. The number of hours. This value will be truncated from the resulting date.
+ * @param {number} minute Optional. The number of minutes. This value will be truncated from the resulting date.
+ * @param {number} second Optional. The number of seconds. This value will be truncated from the resulting date.
+ * @returns {string} A string representation of the date and time of the given year, month and day
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_DATE.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DATE | www.oasis-open.org}
+ * @example rosetta.date(12, 12, 12) // returns 'Thu Dec 12 1912 00:00:00 GMT-0500 (Eastern Standard Time)'
+ * @example rosetta.date(dateObj) // returns 'Thu Dec 12 1912 00:00:00 GMT-0500 (Eastern Standard Time)'
+ */
+function date(yearOrDateTime, month, day, hour, minute, second) {
+ var _a;
+ if (API.isDefaultOpenFormula()) {
+ // Open formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(yearOrDateTime) || yearOrDateTime instanceof Date) {
+ let dates = Array.isArray(yearOrDateTime) ? yearOrDateTime : [yearOrDateTime];
+ const rtnDates = [];
+ for (let index = 0; index < dates.length; index++) {
+ const d = dates[index];
+ let result = openf.DATE(d.getFullYear(), d.getMonth(), d.getDate());
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnDates.push(result);
+ }
+ return rtnDates.length === 1 ? rtnDates[0] : rtnDates;
+ }
+ else {
+ if (yearOrDateTime instanceof Error || month instanceof Error || day instanceof Error) {
+ return (_a = (0, common_1.anyError)(yearOrDateTime, month, day)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ if (month === undefined || day === undefined) {
+ return error.value;
+ }
+ return openf.DATE(yearOrDateTime, month, day);
+ }
+ }
+ else {
+ return notesf.Date(yearOrDateTime, month, day, hour, minute, second);
+ }
+}
+exports.date = date;
+/**
+ * Extracts the day of the month from the specified date.
+ *
+ * @param {string|number|DateOrDateList} dateOrDateList The date, as a string, number, Date object, or Array of Date objects, of the day you are trying to find.
+ * @returns {NumberOrNumberList} Number or Number list. Day portion (or list of days) of the date (or list of dates).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_DAY.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DAY | www.oasis-open.org}
+ * @example rosetta.day(2958465) // returns 31 (openformula)
+ * @example rosetta.day(new Date(1900, 0, 1)) // returns 1
+ */
+function day(dateOrDateList) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnDays = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.DAY(d);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnDays.push(result);
+ });
+ return rtnDays.length === 1 ? rtnDays[0] : rtnDays;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.DAY(dateOrDateList);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Day(dateOrDateList);
+ }
+ }
+}
+exports.day = day;
+/**
+ * Extracts the number of the hour (0 through 23) from a specified Date.
+ *
+ * @param {string|number|DateOrDateList} dateOrDateList The date, as a string, number, Date object, or Array of Date objects, of the hour you are trying to find.
+ * @returns {NumberOrNumberList} Number or Number list. Hour portion (or list of hours) of the given date.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_HOUR.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#HOUR | www.oasis-open.org}
+ * @example rosetta.hour('1/1/1900 1:00') // returns 1 (openformula)
+ * @example rosetta.hour(rosetta.date(95, 11, 20, 8, 58, 12)) // returns 8
+ */
+function hour(dateOrDateList) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnHours = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.HOUR(d);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnHours.push(result);
+ });
+ return rtnHours.length === 1 ? rtnHours[0] : rtnHours;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.HOUR(dateOrDateList);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Hour(dateOrDateList);
+ }
+ }
+}
+exports.hour = hour;
+/**
+ * Extracts the number of the minutes (0 through 23) from a specified Date.
+ *
+ * @param {string|number|DateOrDateList} dateOrDateList The date, as a string, number, Date object, or Array of Date objects, of the minuntes you are trying to find.
+ * @returns {NumberOrNumberList} Number or Number list. Minutes portion (or list of minutes) of the given date.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_MINUTE.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#MINUTE | www.oasis-open.org}
+ * @example rosetta.minute('1/1/1900 1:00') // returns 0 (openformula)
+ * @example rosetta.minute(rosetta.date(95, 11, 20, 8, 58, 12)) // returns 58
+ */
+function minute(dateOrDateList) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnMinutes = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.MINUTE(d);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnMinutes.push(result);
+ });
+ return rtnMinutes.length === 1 ? rtnMinutes[0] : rtnMinutes;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.MINUTE(dateOrDateList);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Minute(dateOrDateList);
+ }
+ }
+}
+exports.minute = minute;
+/**
+ * Extracts the number of the month from the specified date.
+ *
+ * @param {string|number|DateOrDateList} dateOrDateList The date, as a string, number, Date object, or Array of Date objects of the month you are trying to find.
+ * @returns {NumberOrNumberList} Number or Number list. Month portion (or list of days) of the date (or list of dates).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_MONTH.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#MONTH | www.oasis-open.org}
+ * @example rosetta.month(2958465) // returns 12 (openformula)
+ * @example rosetta.month(new Date(1900, 0, 1)) // returns 1
+ */
+function month(dateOrDateList) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnMonths = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.MONTH(d);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnMonths.push(result);
+ });
+ return rtnMonths.length === 1 ? rtnMonths[0] : rtnMonths;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.MONTH(dateOrDateList);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Month(dateOrDateList);
+ }
+ }
+}
+exports.month = month;
+/**
+ * Returns the string representation of the current date and time.
+ *
+ * @returns {Date} A date representation of the current date and time
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_NOW.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#NOW | www.oasis-open.org}
+ * @example rosetta.now() // returns 'Wed Jun 07 2023 12:26:36 GMT-0400 (Eastern Daylight Time)'
+ */
+function now() {
+ return API.isDefaultOpenFormula() ? openf.NOW() : notesf.Now();
+}
+exports.now = now;
+/**
+ * Extracts the number of the seconds (0 through 23) from a specified Date.
+ * This function presumes that leap seconds never exist.
+ *
+ * @param {string|number|DateOrDateList} dateOrDateList The date, as a string, number, Date object, or Array of Date objects, of the seconds you are trying to find.
+ * @returns {NumberOrNumberList} Number or Number list. Seconds portion (or list of seconds) of the given date.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_SECOND.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#SECOND | www.oasis-open.org}
+ * @example rosetta.second('1/1/1900') // returns 0 (open formula)
+ * @example rosetta.second(rosetta.date(95, 11, 20, 8, 58, 12)) // returns 12
+ */
+function second(dateOrDateList) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnSeconds = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.SECOND(d);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnSeconds.push(result);
+ });
+ return rtnSeconds.length === 1 ? rtnSeconds[0] : rtnSeconds;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.SECOND(dateOrDateList);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Second(dateOrDateList);
+ }
+ }
+}
+exports.second = second;
+/**
+ * Constructs and returns a Date object from one of the following combination of time-date parameters:
+ * ( hour, minute, second ), ( year, month, day, hour, minute, second ),
+ * or Date object or array of Date objects, as per the notes formula Time function parameters.
+ *
+ * @param {any} args Date-time object or list of Dates, 6 Numbers representing the date-time, or 3 Numbers from 0 (zero) to 32767 representing the hour, minute, day.
+ * Any value greater than 23 will be divided by 24 and the remainder will be treated as the time value.
+ * @returns {number} A number representing time (as a fraction of a day) or Date-time object of the current time; display usually formatted in current locale.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_TIME.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#TIME | www.oasis-open.org}
+ * @example rosetta.time(1, 1, 1) // returns 0.04237268518518519 (openformula)
+ * @example rosetta.time(93, 12, 24, 12, 30, 40) // returns 1993-12-24 12:30:40.000 -0000
+ * @example rosetta.time(new Date(93, 12, 24, 12, 30, 40)) // returns 1993-12-24 12:30:40.000 -0000
+ */
+function time(...args) {
+ if (API.isDefaultOpenFormula()) {
+ if (args.length === 3) {
+ return openf.TIME(args[0], args[1], args[2]);
+ }
+ return error.value;
+ }
+ else {
+ return notesf.Time(...args);
+ }
+}
+exports.time = time;
+/**
+ * Returns today's date.
+ *
+ * @returns {Date} The date object for the current date and time.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_TODAY.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#TODAY | www.oasis-open.org}
+ * @example rosetta.today() // returns 'Wed Jun 07 2023 12:26:36 GMT-0400 (Eastern Daylight Time)'
+ */
+function today() {
+ return API.isDefaultOpenFormula() ? openf.TODAY() : notesf.Today();
+}
+exports.today = today;
+/**
+ * Extracts the day of the week from a date; if text, uses current locale to convert to a date.
+ * Returns a number that identifies the day.
+ *
+ * @param {string|number|Date} date The date
+ * @param {number} [returnType] A number that determines the type of return value. The default is 1.
+ * - **1** Numbers 1 (Sunday) through 7 (Saturday)
+ * - **2** Numbers 1 (Monday) through 7 (Sunday)
+ * - **3** Numbers 0 (Monday) through 6 (Sunday)
+ * - **11** Numbers 1 (Monday) through 7 (Sunday)
+ * - **12** Numbers 1 (Tuesday) through 7 (Monday)
+ * - **13** Numbers 1 (Wednesday) through 7 (Tuesday)
+ * - **14** Numbers 1 (Thursday) through 7 (Wednesday)
+ * - **15** Numbers 1 (Friday) through 7 (Thursday)
+ * - **16** Numbers 1 (Saturday) through 7 (Friday)
+ * - **17** Numbers 1 (Sunday) through 7 (Saturday)
+ * @returns {number} The day of the week of a given date as a number from 1 through 7. (default)
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_WEEKDAY.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#WEEKDAY | www.oasis-open.org}
+ * @example rosetta.weekday(rosetta.date(1900, 0, 31)) // returns 4
+ * @example rosetta.weekday(2958465) // returns 6 (openf only)
+ * @example rosetta.weekday([rosetta.date(95, 11, 20, 8, 58, 12), rosetta.date(95, 11, 21, 8, 58, 12)]) // returns [2, 3]
+ */
+function weekday(dateOrDateList, returnType = 1) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnDays = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.WEEKDAY(d, returnType);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnDays.push(result);
+ });
+ return rtnDays.length === 1 ? rtnDays[0] : rtnDays;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.WEEKDAY(dateOrDateList, returnType);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Weekday(dateOrDateList);
+ }
+ }
+}
+exports.weekday = weekday;
+/**
+ * Extracts the number of the month from the specified date.
+ *
+ * @param {string|number|DateOrDateList} dateOrDateList The date, as a string, number, Date object, or Array of Date objects of the year you are trying to find.
+ * @returns {NumberOrNumberList} Number or Number list. Year portion (or list of days) of the date (or list of dates).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_YEAR.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#YEAR | www.oasis-open.org}
+ * @example rosetta.year(2958465) // returns 1995 (openformula)
+ * @example rosetta.year(new Date(1900, 0, 1)) // returns 1900
+ */
+function year(dateOrDateList) {
+ var _a;
+ if (dateOrDateList instanceof Error) {
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ }
+ else {
+ if (API.isDefaultOpenFormula()) {
+ // Open Formula does not accept array of Dates as input, so handle it here
+ if (Array.isArray(dateOrDateList) || dateOrDateList instanceof Date) {
+ let dates = Array.isArray(dateOrDateList) ? dateOrDateList : [dateOrDateList];
+ const rtnYears = [];
+ dates.forEach(d => {
+ var _a;
+ if (d instanceof Error)
+ return (_a = (0, common_1.anyError)(dateOrDateList)) !== null && _a !== void 0 ? _a : error.value;
+ let result = openf.YEAR(d);
+ if (result instanceof Error) {
+ return result;
+ }
+ rtnYears.push(result);
+ });
+ return rtnYears.length === 1 ? rtnYears[0] : rtnYears;
+ }
+ // handle non date objects (string or number)
+ else {
+ return openf.YEAR(dateOrDateList);
+ }
+ }
+ // Notes Formula accepts date or date list only
+ else if (typeof dateOrDateList === 'string' || typeof dateOrDateList === 'number') {
+ return error.value;
+ }
+ else {
+ return notesf.Year(dateOrDateList);
+ }
+ }
+}
+exports.year = year;
+//-----------------------------
+// Open Formula date-time
+/**
+ * Calculates the number of days, months, or years between two dates.
+ *
+ * @param {string|number|Date} start_date A date that represents the first, or starting date of a given period.
+ * @param {string|number|Date} end_date A date that represents the last, or ending, date of the period.
+ * @param {string} unit The type of information that you want returned, where:
+ - "Y": The number of complete years in the period.
+ - "M": The number of complete months in the period.
+ - "D": The number of days in the period.
+ - "MD": The difference between the days in start_date and end_date. The months and years of the dates are ignored.
+ - "YM": The difference between the months in start_date and end_date. The days and years of the dates are ignored
+ - "YD": The difference between the days of start_date and end_date. The years of the dates are ignored.
+ * @returns {Number} Days, months, or years between given dates.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DATEDIF | www.oasis-open.org}
+ * @example rosetta.dateDif('1/1/2001', '1/1/2003', 'Y') // returns 2
+ * @example rosetta.dateDif('6/1/2001', '8/15/2002', 'D') // returns 440
+ */
+function dateDif(start_date, end_date, unit) {
+ return openf.DATEDIF(start_date, end_date, unit);
+}
+exports.dateDif = dateDif;
+/**
+ * Returns the string representation of the date and time from given text.
+ *
+ * @param {string} date_text Text that represents a date in an OpenFormula date format, or a reference to a value that contains text that represents a date in an OpenFormula date format.
+ * @returns {Date} A string representation of the date and time of the given date.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DATEVALUE | www.oasis-open.org}
+ * @example rosetta.dateValue('1/1/1900') // returns new Date(1990, 0, 1);
+ */
+function dateValue(date_text) {
+ return openf.DATEVALUE(date_text);
+}
+exports.dateValue = dateValue;
+/**
+ * Returns the number of days between two dates.
+ *
+ * @param {string|number|Date} endDate A date that represents the last, or ending, date of the period
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period
+ * @returns {number} Number of days between two given dates.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DAYS | www.oasis-open.org}
+ * @example rosetta.days('1/2/1900', '1/1/1900') // returns 1
+ */
+function days(endDate, startDate) {
+ return openf.DAYS(endDate, startDate);
+}
+exports.days = days;
+/**
+ * Calculates the number of days between two dates based on a 360-day year.
+ *
+ * @param {string|number|Date} endDate A date that represents the last, or ending, date of the period.
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period.
+ * @param {string} [method] Optional. A logical value that specifies whether to use the U.S. or European
+ * method in the calculation. The default is FALSE.
+ * - **FALSE** U.S. (NASD) method. If the starting date is the last day of a month, it
+ * becomes equal to the 30th day of the same month. If the ending date is
+ * the last day of a month and the starting date is earlier than the 30th
+ * day of a month, the ending date becomes equal to the 1st day of the next
+ * month; otherwise the ending date becomes equal to the 30th day of the
+ * same month.
+ * - **TRUE** European method. Starting dates and ending dates that occur on the 31st
+ * day of a month become equal to the 30th day of the same month.
+ * @returns {number} Number of days between two given dates based on a 360-day year.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DAYS360 | www.oasis-open.org}
+ * @example rosetta.days360('1/1/1901', '12/31/1901', true) // returns 359
+ */
+function days360(startDate, endDate, method = false) {
+ return openf.DAYS360(startDate, endDate, method);
+}
+exports.days360 = days360;
+/**
+ * Returns the date and time that is the indicated number of months before or after the start date.
+ *
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period.
+ * @param {number} months The number of months before or after start_date. A positive value for
+ * months yields a future date; a negative value yields a past date.
+ * @returns {Date} The date of the given date and number of months.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#EDATE | www.oasis-open.org}
+ * @example rosetta.eDate(new Date(2011, 0, 23), 1) // returns new Date(2011, 1, 23)
+ */
+function eDate(startDate, months) {
+ return openf.EDATE(startDate, months);
+}
+exports.eDate = eDate;
+/**
+ * Returns the string representation of the date and time of the last day of the
+ * month before or after a specified number of months.
+ *
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period.
+ * @param {number} months Number of months before or after start_date. A positive value for months
+ * yields a future date; a negative value yields a past date.
+ * @returns {Date} The date of the given date number of months.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#EOMONTH | www.oasis-open.org}
+ * @example rosetta.eoMonth('1/1/2005', 12) // returns new Date('1/1/2005', 12)
+ */
+function eoMonth(startDate, months) {
+ return openf.EOMONTH(startDate, months);
+}
+exports.eoMonth = eoMonth;
+/**
+ * Calculates the number of years, months, days, hours, minutes and seconds from a specified number of seconds.
+ *
+ * @param {number} second Number of seconds.
+ * @returns {string} A string representing the years, months, days, hours, minutes and seconds based on the given number of seconds.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#INTERVAL | www.oasis-open.org}
+ * @example rosetta.interval(10000000) // returns 'P3M25DT17H46M40S'
+ */
+function interval(second) {
+ return openf.INTERVAL(second);
+}
+exports.interval = interval;
+/**
+ * Returns the number of the ISO week number of the year for a given date.
+ *
+ * @param {string|number|Date} date The date.
+ * @returns {number} Number of the week in the year of given date.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ISOWEEKNUM | www.oasis-open.org}
+ * @example rosetta.isoWeekNum('1/8/1901') // returns 2
+ */
+function isoWeekNum(date) {
+ return openf.ISOWEEKNUM(date);
+}
+exports.isoWeekNum = isoWeekNum;
+/**
+ * Return the number of whole workdays between two dates. Working days exclude
+ * weekends and any dates identified in holidays.
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period
+ * @param {string|number|Date} endDate A date that represents the last, or ending, date of the period
+ * @param {Array} [holidays] An optional range of one or more dates to exclude from the working
+ * calendar, such as state and federal holidays and floating holidays.
+ * @returns {number} The number of whole workdays between two dates from call to OpenFormula
+ * NETWORKDAYS function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#NETWORKDAYS | www.oasis-open.org}
+ */
+function netWorkDays(startDate, endDate, holidays) {
+ return openf.NETWORKDAYS(startDate, endDate, holidays);
+}
+exports.netWorkDays = netWorkDays;
+/**
+ * Return the number of whole workdays between two dates using parameters to
+ * indicate which and how many days are weekend days.
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period
+ * @param {string|number|Date} endDate A date that represents the last, or ending, date of the period
+ * @param {string} [weekend] Indicates the days of the week that are weekend days and are
+ * not included in the number of whole working days between start_date and end_date.
+ * Weekend is a weekend number or string that specifies when weekends occur.
+ * <br><br>
+ * Weekend *number* values indicate the following weekend days:
+ * - **1** Saturday, Sunday (Default value)
+ * - **2** Sunday, Monday
+ * - **3** Monday, Tuesday
+ * - **4** Tuesday, Wednesday
+ * - **5** Wednesday, Thursday
+ * - **6** Thursday, Friday
+ * - **7** Friday, Saturday
+ * - **11** Sunday only
+ * - **12** Monday only
+ * - **13** Tuesday only
+ * - **14** Wednesday only
+ * - **15** Thursday only
+ * - **16** Friday only
+ * - **17** Saturday only
+ *
+ * Weekend *string* values are seven characters long and each character in the string
+ * represents a day of the week, starting with Monday. 1 represents a non-workday
+ * and 0 represents a workday. Only the characters 1 and 0 are permitted in the
+ * string. Using 1111111 will always return 0.
+ *
+ * For example, 0000011 would result in a weekend that is Saturday and Sunday.
+ * @param {Array} ['holidays'] An optional range of one or more dates to exclude from the working
+ * calendar, such as state and federal holidays and floating holidays.
+ * @returns {number} The number of whole workdays between two dates from call to OpenFormula
+ * NETWORKDAYs.INTL function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#NETWORkDAYS.INTL | www.oasis-open.org}
+ */
+netWorkDays.intl = (startDate, endDate, weekend, holidays) => {
+ return openf_compat.NETWORKDAYSINTL(startDate, endDate, weekend, holidays);
+};
+exports.netWorkDaysIntl = netWorkDays.intl;
+/**
+ * Converts a time in the form of text to a serial number.
+ *
+ * @param {string} timeText The time represented by a text string.
+ * @returns {number} The decimal number of the time represented by a text string. The decimal
+ * number is a value ranging from 0 (zero) to 0.99988426, representing the times
+ * from 0:00:00 (12:00:00 AM) to 23:59:59 (11:59:59 P.M.).
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#TIMEVALUE | www.oasis-open.org}
+ * @example rosetta.timeValue('1/1/1900 12:00:00') // returns ~ 0.5
+ */
+function timeValue(timeText) {
+ return openf.TIMEVALUE(timeText);
+}
+exports.timeValue = timeValue;
+/**
+ * Converts a date to a number representing where the week falls numerically with a year.
+ *
+ * There are two systems used for this function:
+ * - **System 1** The week containing January 1 is the first week of the year, and is numbered week 1.
+ * - **System 2** The week containing the first Thursday of the year is the first week of the year,
+ * and is numbered as week 1. This system is the methodology specified in ISO 8601,
+ * which is commonly known as the European week numbering system.
+ *
+ * @param {string|number|Date} date A date within the week.
+ * @param {number} [return_type] Optional. A number that determines on which day the week begins. The default is 1.
+ * - **1** Sunday, System 1 (Default value)
+ * - **2** Monday, System 1
+ * - **11** Monday, System 1
+ * - **12** Tuesday, System 1
+ * - **13** Wednesday, System 1
+ * - **14** Thursday, System 1
+ * - **15** Friday, System 1
+ * - **16** Saturday, System 1
+ * - **17** Sunday, System 1
+ * - **21** Monday, System 2
+ * @returns {number} The week number of given date.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#WEEKNUM | www.oasis-open.org}
+ * @example rosetta.weekNum('2/1/1909', 2) // returns 6
+ */
+function weekNum(date, returnType = 1) {
+ return openf.WEEKNUM(date, returnType);
+}
+exports.weekNum = weekNum;
+/**
+ * Return the serial number of the date before or after a specified number of
+ * workdays.
+ * @param {string|number|Error} startDate A date that represents the first, or starting date of a given period
+ * @param {number} days The number of nonweekend and nonholiday days before or after start_date.
+ * A positive value for days yields a future date; a negative value yields a past date.
+ * @param {Array} [holidays] An optional range of one or more dates to exclude from the working
+ * calendar, such as state and federal holidays and floating holidays.
+ * @returns {number} The number of whole workdays between two dates from call to OpenFormula WORKDAY function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#WORKDAY | www.oasis-open.org}
+ */
+function workDay(startDate, days, holidays) {
+ return openf.WORKDAY(startDate, days, holidays);
+}
+exports.workDay = workDay;
+/**
+ * Return the string representation of the date before or after a specified number of
+ * workdays using parameters to indicate which and how many days are weekend days.
+ * @param {string} startDate A date that represents the first, or starting date of a given period
+ * @param {number} day The number of nonweekend and nonholiday days before or after start_date.
+ * A positive value for days yields a future date; a negative value yields a past date.
+ * @param {string} [weekend] Indicates the days of the week that are weekend days and are not
+ * considered working days. Weekend is a weekend number or string that specifies
+ * when weekends occur.
+ *
+ * Weekend number values indicate the following weekend days:
+ * - **1** Saturday, Sunday (Default value)
+ * - **2** Sunday, Monday
+ * - **3** Monday, Tuesday
+ * - **4** Tuesday, Wednesday
+ * - **5** Wednesday, Thursday
+ * - **6** Thursday, Friday
+ * - **7** Friday, Saturday
+ * - **11** Sunday only
+ * - **12** Monday only
+ * - **13** Tuesday only
+ * - **14** Wednesday only
+ * - **15** Thursday only
+ * - **16** Friday only
+ * - **17** Saturday only
+ *
+ * Weekend string values are seven characters long and each character in the string
+ * represents a day of the week, starting with Monday. 1 represents a non-workday
+ * and 0 represents a workday. Only the characters 1 and 0 are permitted in the
+ * string. Using 1111111 will always return 0.
+ *
+ * For example, 0000011 would result in a weekend that is Saturday and Sunday.
+ * @param {Array} [holidays] An optional set of one or more dates that are to be excluded
+ * from the working day calendar. Holidays shall be a range of cells that contain
+ * the dates, or an array constant of the serial values that represent those dates.
+ * The ordering of dates or serial values in holidays can be arbitrary.
+ * @returns {string} A string representation of the date and time before or after the given date
+ * from call to OpenFormula WORKDAY.INTL function
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#WORKDAY.INTL | www.oasis-open.org}
+ */
+workDay.intl = (startDate, days, weekend, holidays) => {
+ return openf_compat.WORKDAYINTL(startDate, days, weekend, holidays);
+};
+exports.workDayIntl = workDay.intl;
+/**
+ * Returns the year fraction representing the number of whole days between start_date and end_date.
+ *
+ * @param {string|number|Date} startDate A date that represents the first, or starting date of a given period.
+ * @param {string|number|Date} endDate A date that represents the last, or ending, date of the period.
+ * @param {number} [basis] The type of day count basis to use:
+ * - **0** US (NASD) 30/360 (Default value)
+ * - **1** Actual/actual
+ * - **2** Actual/360
+ * - **3** Actual/365
+ * - **4** European 30/360
+ * @returns {number} The year fraction of whole days between given dates.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#YEARFRAC | www.oasis-open.org}
+ * @example rosetta.yearFrac('1/31/1900', '3/31/1900', 0) // returns ~ 0.16666666666666666
+ * @example rosetta.yearFrac('1/1/1904', '1/1/1905', 1) // returns 1
+ */
+function yearFrac(startDate, endDate, basis = 0) {
+ return openf.YEARFRAC(startDate, endDate, basis);
+}
+exports.yearFrac = yearFrac;
+//-----------------------------
+// Notes @functions date-time
+/**
+ * Adjusts the specified time-date value by the number of years, months, days, hours, minutes, and/or seconds you specify.
+ * The amount of adjustment may be positive or negative.
+ *
+ * @param {DateOrDateList} dateOrDateList The Date or list of Dates you want to increment. This should be a single date, not a range.
+ * @param {number} years The number of years to increment by.
+ * @param {number} months The number of months to increment by.
+ * @param {number} days The number of days to increment by.
+ * @param {number} hours The number of hours to increment by.
+ * @param {number} minutes The number of minutes to increment by.
+ * @param {number} seconds The number of seconds to increment by.
+ * @returns {DateOrDateList} The adjusted date or list of adjusted dates.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ADJUST.html | www.hcltechsw.com}
+ * @example rosetta.adjust(rosetta.date(2006, 2, 2), 0, 2, 28, 0, 0, 0) // returns 2006, 4, 30
+ */
+function adjust(dateOrDateList, years, months, days, hours, minutes, seconds) {
+ return notesf.Adjust(dateOrDateList, years, months, days, hours, minutes, seconds);
+}
+exports.adjust = adjust;
+/**
+ * Returns the number of business days in one or more date ranges.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_BUSINESSDAYS_FUNCTION.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function businessDays() {
+ return notesf.BusinessDays();
+}
+exports.businessDays = businessDays;
+/**
+ * Returns the time-date when the document was created.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_CREATED.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function created() {
+ return notesf.Created();
+}
+exports.created = created;
+/**
+ * Returns a time-date value indicating when the document was modified initially.
+ * @throw {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_MODIFIED.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function modified() {
+ return notesf.Modified();
+}
+exports.modified = modified;
+/**
+ * Builds a time-date value from separate date, time, and time zone values.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_TIMEMERGE.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function timeMerge() {
+ return notesf.TimeMerge();
+}
+exports.timeMerge = timeMerge;
+/**
+ * Returns the time-date value that corresponds to tomorrow's date.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_TOMORROW.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function tomorrow() {
+ return notesf.Tomorrow();
+}
+exports.tomorrow = tomorrow;
+/**
+ * Returns the time-date value which corresponds to yesterday's date.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_YESTERDAY.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function yesterday() {
+ return notesf.Yesterday();
+}
+exports.yesterday = yesterday;
+/**
+ * Returns the time zone setting of the current computer or of a time-date value,
+ * and indicates if daylight-saving time is observed.
+ *
+ * The time zone is represented as the number of hours that must be added to the
+ * time-date to convert it to Greenwich Mean Time.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ZONE.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function zone() {
+ return notesf.Zone();
+}
+exports.zone = zone;
+/**
+ * Returns the current operating system's time zone settings in canonical time zone
+ * format.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_GETCURRENTTIMEZONE.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function getCurrentTimeZone() {
+ return notesf.GetCurrentTimeZone();
+}
+exports.getCurrentTimeZone = getCurrentTimeZone;
+/**
+ * Returns information about language codes.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_LOCALE_5907.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+function locale() {
+ return notesf.Locale();
+}
+exports.locale = locale;
+/**
+ * Indicates the time and date when the document was last accessed by a Notes®
+ * client, whether for reading or editing.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ACCESSED.html | www.hcltechsw.com}
+ */
+function accessed() {
+ return notesf.Accessed();
+}
+exports.accessed = accessed;
+//# sourceMappingURL=date-time.js.map
\ No newline at end of file
diff --git a/javadoc/dde.js.html b/javadoc/dde.js.html
new file mode 100644
index 00000000..a2b07f50
--- /dev/null
+++ b/javadoc/dde.js.html
@@ -0,0 +1,60 @@
+Source: dde.js
"use strict";
+/**
+ * @file dde
+ * @module DDE (Dynamic Data Exchange)
+ * @category DDE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ddeTerminate = exports.ddePoke = exports.ddeInitiate = exports.ddeExecute = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesf_base = tslib_1.__importStar(require("../notes/dde"));
+const notesf = () => notesf_base;
+exports._notes = notesf_base;
+//-----------------------------
+// Notes @functions DDE
+/**
+ * Passes the specified command string to the DDE application, which is identified
+ * by the conversation ID. @DDEExecute is always used in conjunction with
+ * @DDEInitiate and @DDETerminate.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DDEEXECUTE.html|www.hcltechsw.com }
+ */
+function ddeExecute() {
+ return notesf().DDEExecute();
+}
+exports.ddeExecute = ddeExecute;
+/**
+ * Initiates a conversation with a DDE server, and returns the conversation ID.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DDEINITIATE.html|www.hcltechsw.com }
+ */
+function ddeInitiate() {
+ return notesf().DDEInitiate();
+}
+exports.ddeInitiate = ddeInitiate;
+/**
+ * Deposits unsolicited data into the specified location within the DDE server
+ * application. If the data was successfully inserted into the target location,
+ * @DDEPoke returns an ACK (acknowledgement) with the value @True(1); if the
+ * attempt was not successful, the call returns a NACK (negative acknowledgment)
+ * with the value @False(0). If the conversation ID is invalid, an error is
+ * returned (see @IsError).
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DDEPOKE.html|www.hcltechsw.com }
+ */
+function ddePoke() {
+ return notesf().DDEPoke();
+}
+exports.ddePoke = ddePoke;
+/**
+ * Terminates the conversation with a DDE application.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DDETERMINATE.html|www.hcltechsw.com }
+ */
+function ddeTerminate() {
+ return notesf().DDETerminate();
+}
+exports.ddeTerminate = ddeTerminate;
+//# sourceMappingURL=dde.js.map
\ No newline at end of file
diff --git a/javadoc/design.js.html b/javadoc/design.js.html
new file mode 100644
index 00000000..108193f8
--- /dev/null
+++ b/javadoc/design.js.html
@@ -0,0 +1,215 @@
+Source: design.js
"use strict";
+/**
+ * @file Design
+ * @module design
+ * @category Design
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/design"));
+exports._notes = notesc;
+/**
+ * Displays the Properties box for the current document.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNDOCUMENTINFO.html|www.hcltechsw.com }
+ */
+exports.designDocumentInfo = () => {
+ return notesc.DesignDocumentInfo();
+};
+/**
+ * Displays the Properties box for the current form, subform, or page.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMATTRIBUTES.html|www.hcltechsw.com }
+ */
+exports.designFormAttributes = () => {
+ return notesc.DesignFormAttributes();
+};
+/**
+ * Displays the Properties box for the currently selected field.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMFIELDDEF.html|www.hcltechsw.com }
+ */
+exports.designFormFieldDef = () => {
+ return notesc.DesignFormFieldDef();
+};
+/**
+ * Creates a new field on a form or subform.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMNEWFIELD.html|www.hcltechsw.com }
+ */
+exports.designFormNewField = () => {
+ return notesc.DesignFormNewField();
+};
+/**
+ * Displays the Design - Forms view of the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMS.html|www.hcltechsw.com }
+ */
+exports.designForms = () => {
+ return notesc.DesignForms();
+};
+/**
+ * Turns a single-use field into a shared field.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMSHAREFIELD.html|www.hcltechsw.com }
+ */
+exports.designFormShareField = () => {
+ return notesc.DesignFormShareField();
+};
+/**
+ * Displays the Insert Shared Field dialog box, where the user can select a shared
+ * field to place on the current form or subform.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMUSEFIELD.html|www.hcltechsw.com }
+ */
+exports.designFormUseField = () => {
+ return notesc.DesignFormUseField();
+};
+/**
+ * Displays the design pane and sets the Event edit control to Window Title, so you
+ * can define a formula for a form's window title.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNFORMWINDOWTITLE.html|www.hcltechsw.com }
+ */
+exports.designFormWindowTitle = () => {
+ return notesc.DesignFormWindowTitle();
+};
+/**
+ * Displays the About document in Edit mode for the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNHELPABOUTDOCUMENT.html|www.hcltechsw.com }
+ */
+exports.designHelpAboutDocument = () => {
+ return notesc.DesignHelpAboutDocument();
+};
+/**
+ * Displays the Using document in Edit mode for the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNHELPUSINGDOCUMENT.html|www.hcltechsw.com }
+ */
+exports.designHelpUsingDocument = () => {
+ return notesc.DesignHelpUsingDocument();
+};
+/**
+ * Displays the Design Icon dialog box, where you can edit the icon for the
+ * currently selected database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNICON.html|www.hcltechsw.com }
+ */
+exports.designIcon = () => {
+ return notesc.DesignIcon();
+};
+/**
+ * Displays the Agents and Release 3 macros in the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNMACROS.html|www.hcltechsw.com }
+ */
+exports.designMacros = () => {
+ return notesc.DesignMacros();
+};
+/**
+ * Displays the Refresh Database Design dialog box, where the user can choose a
+ * server that contains the design template for the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNREFRESH.html|www.hcltechsw.com }
+ */
+exports.designRefresh = () => {
+ return notesc.DesignRefresh();
+};
+/**
+ * Displays the Replace Database Design dialog box, where the user can choose a
+ * design template to replace that of the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNREPLACE.html|www.hcltechsw.com }
+ */
+exports.designReplace = () => {
+ return notesc.DesignReplace();
+};
+/**
+ * Displays the Design - Shared Fields view in the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNSHAREDFIELDS.html|www.hcltechsw.com }
+ */
+exports.designSharedFields = () => {
+ return notesc.DesignSharedFields();
+};
+/**
+ * Displays the Design Synopsis dialog box so the user can select the types of
+ * information to be included in the synopsis.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNSYNOPSIS.html|www.hcltechsw.com }
+ */
+exports.designSynopsis = () => {
+ return notesc.DesignSynopsis();
+};
+/**
+ * Creates a column in a view or folder, positioned after the last column.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWAPPENDCOLUMN.html|www.hcltechsw.com }
+ */
+exports.designViewAppendColumn = () => {
+ return notesc.DesignViewAppendColumn();
+};
+/**
+ * Displays the Properties box for the current view or folder.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWATTRIBUTES.html|www.hcltechsw.com }
+ */
+exports.designViewAttributes = () => {
+ return notesc.DesignViewAttributes();
+};
+/**
+ * Displays the Properties box for the currently selected column.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWCOLUMNDEF.html|www.hcltechsw.com }
+ */
+exports.designViewColumnDef = () => {
+ return notesc.DesignViewColumnDef();
+};
+/**
+ * Displays or hides the action pane.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWEDITACTIONS.html|www.hcltechsw.com }
+ */
+exports.designViewEditActions = () => {
+ return notesc.DesignViewEditActions();
+};
+/**
+ * Displays the Design Form Formula dialog box, where the user can define a formula
+ * that determines which form is used to display documents opened from a particular
+ * view or folder.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWFORMFORMULA.html|www.hcltechsw.com }
+ */
+exports.designViewFormFormula = () => {
+ return notesc.DesignViewFormFormula();
+};
+/**
+ * Creates a new column before the currently selected column in a view or folder.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWNEWCOLUMN.html|www.hcltechsw.com }
+ */
+exports.designViewNewColumn = () => {
+ return notesc.DesignViewNewColumn();
+};
+/**
+ * Displays the Design - Views view in the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWS.html|www.hcltechsw.com }
+ */
+exports.designViews = () => {
+ return notesc.DesignViews();
+};
+/**
+ * Displays the design pane and sets the Define control to View Selection, which
+ * allows you to define a selection formula to determine which documents are
+ * displayed in a view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DESIGNVIEWSELECTFORMULA.html|www.hcltechsw.com }
+ */
+exports.designViewSelectFormula = () => {
+ return notesc.DesignViewSelectFormula();
+};
+//# sourceMappingURL=design.js.map
\ No newline at end of file
diff --git a/javadoc/directory.js.html b/javadoc/directory.js.html
new file mode 100644
index 00000000..272aa9c0
--- /dev/null
+++ b/javadoc/directory.js.html
@@ -0,0 +1,37 @@
+Source: directory.js
"use strict";
+/**
+ * @file Directory
+ * @module directory
+ * @category Directory
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.orgDir = exports.nameLookup = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesf = tslib_1.__importStar(require("../notes/directory"));
+exports._notes = notesf;
+/**
+ * Searches for each specified user name across all Domino® Directories and returns
+ * a list of single text values for each specified user name.
+
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_NAMELOOKUP_7699.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function nameLookup() {
+ return notesf.NameLookup();
+}
+exports.nameLookup = nameLookup;
+/**
+ * In a Service Provider (xSP) environment, returns the name of the subdirectory
+ * for the company with which the currently authenticated user is registered. Notes/
+ * Domino retrieves this information from the organization's certifier document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ORGDIR_FUNCTION.html|www.hcltechsw.com }
+ */
+function orgDir() {
+ return notesf.OrgDir();
+}
+exports.orgDir = orgDir;
+//# sourceMappingURL=directory.js.map
\ No newline at end of file
diff --git a/javadoc/document.js.html b/javadoc/document.js.html
new file mode 100644
index 00000000..e978ad0f
--- /dev/null
+++ b/javadoc/document.js.html
@@ -0,0 +1,583 @@
+Source: document.js
"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDocBeingRecalculated = exports.isDocBeingMailed = exports.isDocBeingLoaded = exports.isDocBeingEdited = exports.inheritedDocumentUniqueID = exports.getFocusTable = exports.docMark = exports.docLength = exports.v3EditPrevField = exports.v3EditNextField = exports.switchForm = exports.showProperties = exports.removeFromFolder = exports.moveToTrash = exports.discoverFolders = exports.chooseFolders = exports.undeleteDocument = exports.showParentPreview = exports.setTargetFrame = exports.openInNewWindow = exports.hardDeleteDocument = exports.docLock = exports.addToFolder = exports.setField = exports.responses = exports.prompt = exports.pickList = exports.isResponseDoc = exports.isUnavailable = exports.isNewDoc = exports.isDocTruncated = exports.isAvailable = exports.getFieldType = exports.getField = exports.formLanguage = exports.documentUniqueID = exports.docOmmittedLength = exports.docFields = exports.deleteField = exports.deleteDocument = exports.author = exports.attachments = exports.attachmentNames = exports.attachmentModifiedTimes = exports.attachmentLengths = exports.allDescendants = exports.allChildren = exports.all = exports._notes_vmx = exports._notes = void 0;
+exports.whichFolders = exports.formTestDocument = exports.unavailable = exports.policyIsFieldLocked = exports.noteID = exports.isDocBeingSaved = void 0;
+const tslib_1 = require("tslib");
+/**
+ * @file Document
+ * @module document
+ * @category Document
+ */
+const notesf_base = tslib_1.__importStar(require("../notes/document"));
+const notesf_vmx = tslib_1.__importStar(require("../notes/voltmx/document"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const common_1 = require("../utils/common");
+const notesf = () => API.isDefaultFrameworkVoltMX() ? notesf_vmx : notesf_base;
+const notesc = notesf; // notes commands are exposed in the notes functions source file; this notesc is just for visual cue
+exports._notes = notesf_base;
+exports._notes_vmx = notesf_vmx;
+/**
+ * Returns the value True.
+ * @returns {Promise<any>}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ALL.html|www.hcltechsw.com }
+ */
+const all = () => {
+ return notesf().All();
+};
+exports.all = all;
+/**
+ * Includes all response documents at all levels for parent documents that match
+ * selection criteria.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ALLCHILDREN.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function allChildren() {
+ return notesf().AllChildren();
+}
+exports.allChildren = allChildren;
+/**
+ * Includes all response and response-to-response documents for parents that match
+ * selection criteria.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ALLDESCENDANTS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function allDescendants() {
+ return notesf().AllDescendants();
+}
+exports.allDescendants = allDescendants;
+/**
+ * Returns a number or a number list containing the length of each attachment to
+ * the current document. The number(s) returned are only approximations; the actual
+ * size(s) of the attachment(s) may be slightly different.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTLENGTHS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function attachmentLengths() {
+ return notesf().AttachmentLengths();
+}
+exports.attachmentLengths = attachmentLengths;
+/**
+ * Returns a datetime that displays the date on which the file attachment
+ * associated with the current document was last modified. If the document contains
+ * more than one file attachment, returns the modification dates in a datetime list.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTMODIFIEDTIMES.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function attachmentModifiedTimes() {
+ return notesf().AttachmentModifiedTimes();
+}
+exports.attachmentModifiedTimes = attachmentModifiedTimes;
+/**
+ * Returns the operating system file names of any files attached to a document. If
+ * there are multiple files attached, the names are returned as a multiple-value
+ * text list.
+ * @returns {TextOrTextList}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTNAMES.html|www.hcltechsw.com }
+ */
+function attachmentNames() {
+ return notesf().AttachmentNames();
+}
+exports.attachmentNames = attachmentNames;
+/**
+ * Returns the number of files attached to a document.
+ * @returns {number}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATTACHMENTS.html|www.hcltechsw.com }
+ */
+function attachments() {
+ return notesf().Attachments();
+}
+exports.attachments = attachments;
+/**
+ * Returns a text list containing the names of the author(s) of the current document.
+ * @returns {string[]}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_AUTHOR.html|www.hcltechsw.com }
+ */
+function author() {
+ return notesf().Author();
+}
+exports.author = author;
+/**
+ * Deletes the current document.
+ * @returns {Promise<any>}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DELETEDOCUMENT.html|www.hcltechsw.com }
+ */
+function deleteDocument() {
+ return notesf().DeleteDocument();
+}
+exports.deleteDocument = deleteDocument;
+/**
+ * Deletes the value of an editable field.
+ * @returns {void}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DELETEFIELD.html|www.hcltechsw.com }
+ */
+function deleteField() {
+ return notesf().DeleteField();
+}
+exports.deleteField = deleteField;
+/**
+ * Returns a list of all the fields in a document.
+
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCFIELDS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function docFields() {
+ return notesf().DocFields();
+}
+exports.docFields = docFields;
+/**
+ * Returns the approximate number of bytes a truncated document lost during
+ * replication. The bytes are the total number of bytes per attachment, OLE object,
+ * large rich text field, or non-summary items that were too large, according to
+ * the replication settings for the database, to be replicated.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCOMITTEDLENGTH.html|www.hcltechsw.com }
+ */
+function docOmmittedLength() {
+ return notesf().DocOmmittedLength();
+}
+exports.docOmmittedLength = docOmmittedLength;
+/**
+ * The universal ID, which uniquely identifies a document across all replicas of a
+ * database. In text format, the universal ID is a 32-character combination of
+ * hexadecimal digits (0-9, A-F).
+ *
+ * The universal ID is also known as the unique ID or UNID.
+ * @returns {string}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCUMENTUNIQUEID.html|www.hcltechsw.com }
+ */
+function documentUniqueID() {
+ return notesf().DocumentUniqueID();
+}
+exports.documentUniqueID = documentUniqueID;
+/**
+ * Returns the language of the current form.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FORMLANGUAGE_FUNCTION.html|www.hcltechsw.com }
+ */
+function formLanguage() {
+ return notesf().FormLanguage();
+}
+exports.formLanguage = formLanguage;
+/**
+ * Returns the value of a specified field.
+ * @param {any} fieldName
+ * @returns {*} value
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_GETFIELD.html|www.hcltechsw.com }
+ */
+const getField = (fieldName) => {
+ return notesf().GetField(fieldName);
+};
+exports.getField = getField;
+/**
+ * Returns the type of a specified field.
+ * @param {any} fieldName - uses current document
+ * @returns {*} field type - possible return values - 'string', 'number', 'date', 'richtext', 'string[]', 'number[]', 'date[], 'richtext[]', and []'
+ */
+const getFieldType = (fieldName) => {
+ return notesf().GetFieldType(fieldName);
+};
+exports.getFieldType = getFieldType;
+/**
+ * Checks a document for the existence of a field.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISAVAILABLE.html|www.hcltechsw.com }
+ */
+function isAvailable() {
+ return notesf().IsAvailable();
+}
+exports.isAvailable = isAvailable;
+/**
+ * Indicates whether the current document has been truncated.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDOCTRUNCATED.html|www.hcltechsw.com }
+ */
+function isDocTruncated() {
+ return notesf().IsDocTruncated();
+}
+exports.isDocTruncated = isDocTruncated;
+/**
+ * For a document being edited, indicates if the document has been saved to disk.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISNEWDOC.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isNewDoc() {
+ return notesf().IsNewDoc();
+}
+exports.isNewDoc = isNewDoc;
+/**
+ * Indicates whether a field name exists in a document.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISUNAVAILABLE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isUnavailable() {
+ return notesf().IsUnavailable();
+}
+exports.isUnavailable = isUnavailable;
+/**
+ * Indicates whether a document is a response to another document.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISRESPONSEDOC.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isResponseDoc() {
+ return notesf().IsResponseDoc();
+}
+exports.isResponseDoc = isResponseDoc;
+/**
+ * Displays a modal window that contains either:
+ * - A view you specify from which the user can select one or more documents.
+ * @pickList returns a column value from the selected document(s).
+ * - A dialog box, displaying information from all available Domino® Directories.
+ * The user can select one or more person, group, server, room, or resource names,
+ * and @pickList returns those names.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PICKLIST.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function pickList() {
+ return notesf().PickList();
+}
+exports.pickList = pickList;
+/**
+ * Get html to generate a prompt.
+ * @param style - The type of prompt to generate
+ * @param title - The title for the prompt
+ * @param [promptString] - Optional. Text to display with the prompt
+ * @param [defaultChoice] - Optional. Default choice to select when the prompt is displayed.
+ * @param [choiceList] - Optional. The list of avaliable choices
+ * @returns A promise that will inject the code for the prompt into the document.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PROMPT.html|www.hcltechsw.com }
+ */
+function prompt(style, title, promptString, defaultChoice, choiceList) {
+ if (!style) {
+ return Promise.reject('Insufficient arguments');
+ }
+ style = common_1.PromptStyle[style.toUpperCase()] || '';
+ if (!style) {
+ return Promise.reject('Invalid Prompt type');
+ }
+ return notesf().Prompt(style, title, promptString, defaultChoice, choiceList);
+}
+exports.prompt = prompt;
+/**
+ * Returns the number of responses (in the current view) to the document.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_RESPONSES.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function responses() {
+ return notesf().Responses();
+}
+exports.responses = responses;
+/**
+ * Assigns a value to a field stored within a document (use @set for temporary
+ * variables). This is similar to using the FIELD keyword, except that @setField
+ * can be used within another @function. If the field does not exist, this
+ * command creates it and applies the specified value to it.
+ * @param {string} fieldName The name of a field in the current document.
+ * @param {any} value The value to set the field.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETFIELD.html|www.hcltechsw.com }
+ */
+function setField(fieldName, value) {
+ return notesf().SetField(fieldName, value);
+}
+exports.setField = setField;
+/* --------------------------------------------------------------- */
+/* Moved from Miscellaneous category */
+/**
+ * Adds current document to one folder while removing it from another. NULL string
+ * can be substituted for either argument to skip the action.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADDTOFOLDER_2068_MEMLIST.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function addToFolder() {
+ return notesf().AddToFolder();
+}
+exports.addToFolder = addToFolder;
+/**
+ * Locks, unlocks, returns the locked status of the current document, or indicates
+ * if a database has document locking enabled.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCLOCK.html|www.hcltechsw.com }
+ */
+function docLock() {
+ return notesf().DocLock();
+}
+exports.docLock = docLock;
+/**
+ * In an agent that runs a formula, @HardDeleteDocument permanently removes the
+ * document currently being processed from the database if the database has soft
+ * deletions enabled. If the database does not have soft deletions enabled,
+ * @HardDeleteDocument performs the same action as @DeleteDocument.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_HARDDELETEDOCUMENT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function hardDeleteDocument() {
+ return notesf().HardDeleteDocument();
+}
+exports.hardDeleteDocument = hardDeleteDocument;
+/**
+ * Opens the specified document within a new window.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENINNEWWINDOW.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function openInNewWindow() {
+ return notesf().OpenInNewWindow();
+}
+exports.openInNewWindow = openInNewWindow;
+/**
+ * Allows you to specify a target frame when opening a view, page, or frameset, or
+ * when composing or editing a document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETTARGETFRAME_4540.html|www.hcltechsw.com }
+ */
+function setTargetFrame() {
+ return notesf().SetTargetFrame();
+}
+exports.setTargetFrame = setTargetFrame;
+/**
+ * Displays the parent document preview pane.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SHOWPARENTPREVIEW_FUNCTION.html|www.hcltechsw.com }
+ */
+function showParentPreview() {
+ return notesf().ShowParentPreview();
+}
+exports.showParentPreview = showParentPreview;
+/**
+ * In a database with "Allow soft deletions" selected, this command restores a
+ * deleted document.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_UNDELETEDOCUMENT_9160_OVER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function undeleteDocument() {
+ return notesf().UndeleteDocument();
+}
+exports.undeleteDocument = undeleteDocument;
+/**
+ * Displays the Folders dialog box, which allows you to select a folder in which to
+ * file the current document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CHOOSEFOLDERS.html|www.hcltechsw.com }
+ */
+function chooseFolders() {
+ return notesc().ChooseFolders();
+}
+exports.chooseFolders = chooseFolders;
+/**
+ * Displays the "Folders containing current document" dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DISCOVERFOLDERS_COMMANDS.html|www.hcltechsw.com }
+ */
+function discoverFolders() {
+ return notesc().DiscoverFolders();
+}
+exports.discoverFolders = discoverFolders;
+/**
+ * Marks the currently selected document for deletion.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MOVETOTRASH_COMMAND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function moveToTrash() {
+ return notesc().MoveToTrash();
+}
+exports.moveToTrash = moveToTrash;
+/**
+ * Removes the selected document from the current folder.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REMOVEFROMFOLDER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function removeFromFolder() {
+ return notesc().RemoveFromFolder();
+}
+exports.removeFromFolder = removeFromFolder;
+/**
+ * Displays the Properties box for the currently selected Notes® object. For
+ * example, if a document is selected in a view, displays the document Properties
+ * box; if a field is selected on a form, displays the field Properties box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SHOWPROPERTIES.html|www.hcltechsw.com }
+ */
+function showProperties() {
+ return notesc().ShowProperties();
+}
+exports.showProperties = showProperties;
+/**
+ * Changes the form used to display the current document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SWITCHFORM_COMMAND.html|www.hcltechsw.com }
+ */
+function switchForm() {
+ return notesc().SwitchForm();
+}
+exports.switchForm = switchForm;
+/**
+ * In a document in Edit mode, moves the insertion point to the next editable field.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_V3EDITNEXTFIELD.html|www.hcltechsw.com }
+ */
+function v3EditNextField() {
+ return notesc().V3EditNextField();
+}
+exports.v3EditNextField = v3EditNextField;
+/**
+ * In a document in Edit mode, moves the insertion point to the first editable field.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_V3EDITPREVFIELD.html|www.hcltechsw.com }
+ */
+function v3EditPrevField() {
+ return notesc().V3EditPrevField();
+}
+exports.v3EditPrevField = v3EditPrevField;
+/**
+ * Returns the approximate size of a document in bytes.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCLENGTH.html|www.hcltechsw.com }
+ */
+function docLength() {
+ return notesf().DocLength();
+}
+exports.docLength = docLength;
+/**
+ * In an agent that runs a formula, indicates whether or not you want to save the
+ * changes to a document.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DOCMARK.html|www.hcltechsw.com }
+ */
+function docMark() {
+ return notesf().DocMark();
+}
+exports.docMark = docMark;
+/**
+ * Returns the name, current row, or current column of the table that is in focus.
+
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_GETFOCUSTABLE.html|www.hcltechsw.com }
+ */
+function getFocusTable() {
+ return notesf().GetFocusTable();
+}
+exports.getFocusTable = getFocusTable;
+/**
+ * The unique ID of the current document's inheritance parent. See
+ * @documentUniqueID for a description of unique IDs.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_INHERITEDDOCUMENTUNIQUEID.html|www.hcltechsw.com }
+ */
+function inheritedDocumentUniqueID() {
+ return notesf().InheritedDocumentUniqueID();
+}
+exports.inheritedDocumentUniqueID = inheritedDocumentUniqueID;
+/**
+ * Checks the current status of the document and returns 1 (True) if the document
+ * is being edited; otherwise returns 0 (False).
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDOCBEINGEDITED.html|www.hcltechsw.com }
+ */
+function isDocBeingEdited() {
+ return notesf().IsDocBeingEdited();
+}
+exports.isDocBeingEdited = isDocBeingEdited;
+/**
+ * Checks the current status of the document and returns 1 (True) if the document
+ * is being loaded into memory for display; otherwise returns 0 (False).
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDOCBEINGLOADED.html|www.hcltechsw.com }
+ */
+function isDocBeingLoaded() {
+ return notesf().IsDocBeingLoaded();
+}
+exports.isDocBeingLoaded = isDocBeingLoaded;
+/**
+ * Checks the current status of the document and returns 1 (True) if the document
+ * is being mailed; otherwise, returns 0 (False).
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDOCBEINGMAILED.html|www.hcltechsw.com }
+ */
+function isDocBeingMailed() {
+ return notesf().IsDocBeingMailed();
+}
+exports.isDocBeingMailed = isDocBeingMailed;
+/**
+ * Checks the current status of the document and returns 1 (True) if the document
+ * is being recalculated; otherwise, returns 0 (False).
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDOCBEINGRECALCULATED.html|www.hcltechsw.com }
+ */
+function isDocBeingRecalculated() {
+ return notesf().IsDocBeingRecalculated();
+}
+exports.isDocBeingRecalculated = isDocBeingRecalculated;
+/**
+ * Checks the current status of the document and returns 1 (True) if the document
+ * is being saved; otherwise, returns 0 (False).
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISDOCBEINGSAVED.html|www.hcltechsw.com }
+ */
+function isDocBeingSaved() {
+ return notesf().IsDocBeingSaved();
+}
+exports.isDocBeingSaved = isDocBeingSaved;
+/**
+ * The ID number of the current document.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NOTEID.html|www.hcltechsw.com }
+ */
+function noteID() {
+ return notesf().NoteID();
+}
+exports.noteID = noteID;
+/**
+ * Indicates whether a field is locked by an administration policy and cannot be
+ * modified.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_POLICYISFIELDLOCKED.html|www.hcltechsw.com }
+ */
+function policyIsFieldLocked() {
+ return notesf().PolicyIsFieldLocked();
+}
+exports.policyIsFieldLocked = policyIsFieldLocked;
+/**
+ * Deletes the value of an editable field.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_UNAVAILABLE.html|www.hcltechsw.com }
+ */
+function unavailable() {
+ return notesf().Unavailable();
+}
+exports.unavailable = unavailable;
+/**
+ * Creates a document using the current form or Page, so you can test its fields,
+ * formulas, and scripts.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FORMTESTDOCUMENT.html|www.hcltechsw.com }
+ */
+function formTestDocument() {
+ return notesc().FormTestDocument();
+}
+exports.formTestDocument = formTestDocument;
+/**
+ * Returns the names of the folders containing the current document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_WHICHFOLDERS_FUNCTION.html|www.hcltechsw.com }
+ */
+function whichFolders() {
+ return notesf().WhichFolders();
+}
+exports.whichFolders = whichFolders;
+//# sourceMappingURL=document.js.map
\ No newline at end of file
diff --git a/javadoc/ecl.js.html b/javadoc/ecl.js.html
new file mode 100644
index 00000000..6fafb3d1
--- /dev/null
+++ b/javadoc/ecl.js.html
@@ -0,0 +1,51 @@
+Source: ecl.js
"use strict";
+/**
+ * @file ecl
+ * @module ECL (Execution Control List)
+ * @category ECL
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refreshECL = exports.editUserECL = exports.editECL = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesf_base = tslib_1.__importStar(require("../notes/ecl"));
+const notesf = () => notesf_base;
+exports._notes = notesf_base;
+//-----------------------------
+// Notes @functions ECL
+/**
+ * Displays the administration "Workstation Security: Execution Control List"
+ * dialog box for a specified address book and name, which lets you change that
+ * administration ECL. Administrators can name Administration ECLs. The name is not
+ * usually a user name, but whatever name the administrator chooses; for example,
+ * Manager, Developer, or LimitedAccess.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITECL.html|www.hcltechsw.com }
+ */
+function editECL() {
+ return notesf().EditECL();
+}
+exports.editECL = editECL;
+/**
+ * Displays the "Workstation Security: Execution Control List" dialog box, which
+ * allows you to change your personal ECL for the current workstation.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITUSERECL.html|www.hcltechsw.com }
+ */
+function editUserECL() {
+ return notesf().EditUserECL();
+}
+exports.editUserECL = editUserECL;
+/**
+ * Copies the administration execution control list from a specified Address Book
+ * and name to your personal workstation ECL.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REFRESHECL.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function refreshECL() {
+ return notesf().RefreshECL();
+}
+exports.refreshECL = refreshECL;
+//# sourceMappingURL=ecl.js.map
\ No newline at end of file
diff --git a/javadoc/edit.js.html b/javadoc/edit.js.html
new file mode 100644
index 00000000..2bd378a4
--- /dev/null
+++ b/javadoc/edit.js.html
@@ -0,0 +1,513 @@
+Source: edit.js
"use strict";
+/**
+ * @file Edit
+ * @module edit
+ * @category Edit
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.editTop = exports.editTableInsertRowColumn = exports.editTableFormat = exports.editTableDeleteRowColumn = exports.editShowHideHiddenChars = exports.editSelectByDate = exports.editSelectAll = exports.editRight = exports.editRestoreDocument = exports.editResizePicture = exports.editQuoteSelection = exports.editProfileDocument = exports.editProfile = exports.editPrevField = exports.editPhoneNumbers = exports.editPasteSpecial = exports.editPaste = exports.editOwnerVCard = exports.editOpenLink = exports.editNextField = exports.editMakeDocLink = exports.editLocations = exports.editLinks = exports.editLeft = exports.editInsertText = exports.editInsertTable = exports.editInsertPopup = exports.editInsertPageBreak = exports.editInsertObject = exports.editInsertFileAttachment = exports.editInsertButton = exports.editIndentFirstLine = exports.editIndent = exports.editHorizScrollbar = exports.editHeaderFooter = exports.editGotoField = exports.editFindNext = exports.editFindInPreview = exports.editFind = exports.editEncryptionKeys = exports.editDown = exports.editDocument = exports.editDetach = exports.editDeselectAll = exports.editCut = exports.editCopy = exports.editClear = exports.editButton = exports.editBottom = exports._notes = void 0;
+exports.editUp = exports.editUntruncate = exports.editUndo = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/edit"));
+exports._notes = notesc;
+/**
+ * Moves the insertion point to the end of a document or form.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITBOTTOM.html|www.hcltechsw.com }
+ */
+function editBottom() {
+ return notesc.EditBottom();
+}
+exports.editBottom = editBottom;
+/**
+ * Displays the design pane and the Properties box for the selected button.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITBUTTON.html|www.hcltechsw.com }
+ */
+function editButton() {
+ return notesc.EditButton();
+}
+exports.editButton = editButton;
+/**
+ * Performs the menu command Edit - Delete.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITCLEAR.html|www.hcltechsw.com }
+ */
+function editClear() {
+ return notesc.EditClear();
+}
+exports.editClear = editClear;
+/**
+ * Performs the menu command Edit - Copy.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITCOPY.html|www.hcltechsw.com }
+ */
+function editCopy() {
+ return notesc.EditCopy();
+}
+exports.editCopy = editCopy;
+/**
+ * Performs the menu command Edit - Cut.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITCUT.html|www.hcltechsw.com }
+ */
+function editCut() {
+ return notesc.EditCut();
+}
+exports.editCut = editCut;
+/**
+ * Performs the menu command Edit - Deselect All.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITDESELECTALL.html|www.hcltechsw.com }
+ */
+function editDeselectAll() {
+ return notesc.EditDeselectAll();
+}
+exports.editDeselectAll = editDeselectAll;
+/**
+ * Detaches a file attachment to a location you specify.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITDETACH.html|www.hcltechsw.com }
+ */
+function editDetach() {
+ return notesc.EditDetach();
+}
+exports.editDetach = editDetach;
+/**
+ * Places the current document into the mode you specify. If you don't specify a
+ * mode, toggles between Read and Edit mode.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITDOCUMENT.html|www.hcltechsw.com }
+ */
+function editDocument() {
+ return notesc.EditDocument();
+}
+exports.editDocument = editDocument;
+/**
+ * Moves the insertion point in a document down by the number of lines you specify.
+ * If you don't specify a number, moves the insertion point down one line.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITDOWN.html|www.hcltechsw.com }
+ */
+function editDown() {
+ return notesc.EditDown();
+}
+exports.editDown = editDown;
+/**
+ * Displays the Properties box for the current document, where you can edit its
+ * encryption keys.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITENCRYPTIONKEYS.html|www.hcltechsw.com }
+ */
+function editEncryptionKeys() {
+ return notesc.EditEncryptionKeys();
+}
+exports.editEncryptionKeys = editEncryptionKeys;
+/**
+ * Performs the menu command Edit - Find/Replace.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITFIND.html|www.hcltechsw.com }
+ */
+function editFind() {
+ return notesc.EditFind();
+}
+exports.editFind = editFind;
+/**
+ * Performs the menu command Edit - Find/Replace without moving the focus to the
+ * editing window. This allows searches to take place when the focus is on the view
+ * or folder panes.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITFINDINPREVIEW.html|www.hcltechsw.com }
+ */
+function editFindInPreview() {
+ return notesc.EditFindInPreview();
+}
+exports.editFindInPreview = editFindInPreview;
+/**
+ * Performs the menu command Edit - Find Next.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITFINDNEXT.html|www.hcltechsw.com }
+ */
+function editFindNext() {
+ return notesc.EditFindNext();
+}
+exports.editFindNext = editFindNext;
+/**
+ * In a document in Edit mode, places the insertion point in a field you specify.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITGOTOFIELD.html|www.hcltechsw.com }
+ */
+function editGotoField() {
+ return notesc.EditGotoField();
+}
+exports.editGotoField = editGotoField;
+/**
+ * Displays the Properties box for the current document or form, which allows you
+ * to set headers, footers, and other print attributes.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITHEADERFOOTER.html|www.hcltechsw.com }
+ */
+function editHeaderFooter() {
+ return notesc.EditHeaderFooter();
+}
+exports.editHeaderFooter = editHeaderFooter;
+/**
+ * Toggles the horizontal scroll bar in a document.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITHORIZSCROLLBAR.html|www.hcltechsw.com }
+ */
+function editHorizScrollbar() {
+ return notesc.EditHorizScrollbar();
+}
+exports.editHorizScrollbar = editHorizScrollbar;
+/**
+ * Indents a paragraph 1/4 inch. The entire paragraph is indented, as well as any
+ * paragraphs that are subsequently typed below it, until the user disables
+ * indenting.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINDENT.html|www.hcltechsw.com }
+ */
+function editIndent() {
+ return notesc.EditIndent();
+}
+exports.editIndent = editIndent;
+/**
+ * Indents the first line of a paragraph 1/4 inch. The first line of the current
+ * paragraph is indented, as well as first lines of subsequently typed paragraphs,
+ * until the user disables indenting. (A carriage return defines a new paragraph.)
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINDENTFIRSTLINE.html|www.hcltechsw.com }
+ */
+function editIndentFirstLine() {
+ return notesc.EditIndentFirstLine();
+}
+exports.editIndentFirstLine = editIndentFirstLine;
+/**
+ * Creates a new button and displays the design pane, where the user can define a
+ * formula, simple action(s), LotusScript®, or JavaScript™ for the button.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTBUTTON.html|www.hcltechsw.com }
+ */
+function editInsertButton() {
+ return notesc.EditInsertButton();
+}
+exports.editInsertButton = editInsertButton;
+/**
+ * Attaches a file to a document.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTFILEATTACHMENT.html|www.hcltechsw.com }
+ */
+function editInsertFileAttachment() {
+ return notesc.EditInsertFileAttachment();
+}
+exports.editInsertFileAttachment = editInsertFileAttachment;
+/**
+ * Inserts an object into a document, form, or subform.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTOBJECT.html|www.hcltechsw.com }
+ */
+function editInsertObject() {
+ return notesc.EditInsertObject();
+}
+exports.editInsertObject = editInsertObject;
+/**
+ * Inserts a forced page break into a document, form, subform, or page.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTPAGEBREAK.html|www.hcltechsw.com }
+ */
+function editInsertPageBreak() {
+ return notesc.EditInsertPageBreak();
+}
+exports.editInsertPageBreak = editInsertPageBreak;
+/**
+ * Creates a hotspot that displays text.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTPOPUP.html|www.hcltechsw.com }
+ */
+function editInsertPopup() {
+ return notesc.EditInsertPopup();
+}
+exports.editInsertPopup = editInsertPopup;
+/**
+ * Displays the Create Table dialog box, where the user can specify the number of
+ * rows and columns in a new table.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTTABLE.html|www.hcltechsw.com }
+ */
+function editInsertTable() {
+ return notesc.EditInsertTable();
+}
+exports.editInsertTable = editInsertTable;
+/**
+ * Inserts the specified string at the current cursor position.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITINSERTTEXT.html|www.hcltechsw.com }
+ */
+function editInsertText() {
+ return notesc.EditInsertText();
+}
+exports.editInsertText = editInsertText;
+/**
+ * Moves the insertion point in a document, form, subform, or page to the left by
+ * the number of spaces you specify. If you don't specify a number, moves the
+ * insertion point one space to the left.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITLEFT.html|www.hcltechsw.com }
+ */
+function editLeft() {
+ return notesc.EditLeft();
+}
+exports.editLeft = editLeft;
+/**
+ * Displays the External Links dialog box.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITLINKS.html|www.hcltechsw.com }
+ */
+function editLinks() {
+ return notesc.EditLinks();
+}
+exports.editLinks = editLinks;
+/**
+ * Opens the Personal Address Book to the Locations view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITLOCATIONS.html|www.hcltechsw.com }
+ */
+function editLocations() {
+ return notesc.EditLocations();
+}
+exports.editLocations = editLocations;
+/**
+ * Creates a link to the current document and copies it to the Clipboard. The user
+ * can paste the link into any rich text field.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITMAKEDOCLINK.html|www.hcltechsw.com }
+ */
+function editMakeDocLink() {
+ return notesc.EditMakeDocLink();
+}
+exports.editMakeDocLink = editMakeDocLink;
+/**
+ * In a document in Edit mode, moves the insertion point to the next editable field
+ * in the document, working left to right, beginning to end.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITNEXTFIELD.html|www.hcltechsw.com }
+ */
+function editNextField() {
+ return notesc.EditNextField();
+}
+exports.editNextField = editNextField;
+/**
+ * Opens the selected link.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITOPENLINK.html|www.hcltechsw.com }
+ */
+function editOpenLink() {
+ return notesc.EditOpenLink();
+}
+exports.editOpenLink = editOpenLink;
+/**
+ * Displays the My Contact/vCard Edit dialog using the Contact form.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITOWNERVCARD.html|www.hcltechsw.com }
+ */
+function editOwnerVCard() {
+ return notesc.EditOwnerVCard();
+}
+exports.editOwnerVCard = editOwnerVCard;
+/**
+ * Performs the menu command Edit - Paste.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITPASTE.html|www.hcltechsw.com }
+ */
+function editPaste() {
+ return notesc.EditPaste();
+}
+exports.editPaste = editPaste;
+/**
+ * Displays the Paste Special dialog box.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITPASTESPECIAL.html|www.hcltechsw.com }
+ */
+function editPasteSpecial() {
+ return notesc.EditPasteSpecial();
+}
+exports.editPasteSpecial = editPasteSpecial;
+/**
+ * Displays the Server/Connections view of the Personal Address Book.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITPHONENUMBERS.html|www.hcltechsw.com }
+ */
+function editPhoneNumbers() {
+ return notesc.EditPhoneNumbers();
+}
+exports.editPhoneNumbers = editPhoneNumbers;
+/**
+ * In a document in Edit mode, moves the insertion point to the previous editable
+ * field in the document, working right to left, end to beginning.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITPREVFIELD.html|www.hcltechsw.com }
+ */
+function editPrevField() {
+ return notesc.EditPrevField();
+}
+exports.editPrevField = editPrevField;
+/**
+ * Opens a new or existing profile document in Edit mode.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITPROFILE.html|www.hcltechsw.com }
+ */
+function editProfile() {
+ return notesc.EditProfile();
+}
+exports.editProfile = editProfile;
+/**
+ * Creates a new or opens an existing profile document in Edit mode.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITPROFILEDOCUMENT_COMMAND.html|www.hcltechsw.com }
+ */
+function editProfileDocument() {
+ return notesc.EditProfileDocument();
+}
+exports.editProfileDocument = editProfileDocument;
+/**
+ * Makes selected text look like an Internet-style reply by prefixing each line
+ * with a greater-than sign and removing attachments and other objects. This sets
+ * each line of the message to a default length, preventing it from wrapping in
+ * unexpected places when sent to non-Notes users.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITQUOTESELECTION.html|www.hcltechsw.com }
+ */
+function editQuoteSelection() {
+ return notesc.EditQuoteSelection();
+}
+exports.editQuoteSelection = editQuoteSelection;
+/**
+ * Displays the proportions of the selected graphic at the end of the screen. The
+ * user can size the picture by dragging the mouse in the appropriate direction.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITRESIZEPICTURE.html|www.hcltechsw.com }
+ */
+function editResizePicture() {
+ return notesc.EditResizePicture();
+}
+exports.editResizePicture = editResizePicture;
+/**
+ * Performs the menu command Edit - Restore.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITRESTOREDOCUMENT_COMMAND.html|www.hcltechsw.com }
+ */
+function editRestoreDocument() {
+ return notesc.EditRestoreDocument();
+}
+exports.editRestoreDocument = editRestoreDocument;
+/**
+ * Moves the insertion point in a document to the right by the number of spaces you
+ * specify. If you don't specify a number, moves the insertion point one space to
+ * the right.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITRIGHT.html|www.hcltechsw.com }
+ */
+function editRight() {
+ return notesc.EditRight();
+}
+exports.editRight = editRight;
+/**
+ * Performs the menu command Edit - Select All.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITSELECTALL.html|www.hcltechsw.com }
+ */
+function editSelectAll() {
+ return notesc.EditSelectAll();
+}
+exports.editSelectAll = editSelectAll;
+/**
+ * Displays the Select by Date dialog box, where the user indicates which documents
+ * should be selected in the view or folder, according to the date they were
+ * created or last modified.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITSELECTBYDATE.html|www.hcltechsw.com }
+ */
+function editSelectByDate() {
+ return notesc.EditSelectByDate();
+}
+exports.editSelectByDate = editSelectByDate;
+/**
+ * Toggles the display of the hidden characters (such as spaces, tabs, and carriage
+ * returns) in a document, form, or subform.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITSHOWHIDEHIDDENCHARS.html|www.hcltechsw.com }
+ */
+function editShowHideHiddenChars() {
+ return notesc.EditShowHideHiddenChars();
+}
+exports.editShowHideHiddenChars = editShowHideHiddenChars;
+/**
+ * Displays the Delete Row/Column dialog box, where the user can select the number
+ * of rows or columns to delete from the current table.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITTABLEDELETEROWCOLUMN.html|www.hcltechsw.com }
+ */
+function editTableDeleteRowColumn() {
+ return notesc.EditTableDeleteRowColumn();
+}
+exports.editTableDeleteRowColumn = editTableDeleteRowColumn;
+/**
+ * Displays the Properties box for the selected table.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITTABLEFORMAT.html|www.hcltechsw.com }
+ */
+function editTableFormat() {
+ return notesc.EditTableFormat();
+}
+exports.editTableFormat = editTableFormat;
+/**
+ * Displays the Insert Row/Column dialog box, where the user can select the number
+ * of rows or columns to insert into the table.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITTABLEINSERTROWCOLUMN.html|www.hcltechsw.com }
+ */
+function editTableInsertRowColumn() {
+ return notesc.EditTableInsertRowColumn();
+}
+exports.editTableInsertRowColumn = editTableInsertRowColumn;
+/**
+ * Moves the insertion point to the beginning of a document or form.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITTOP.html|www.hcltechsw.com }
+ */
+function editTop() {
+ return notesc.EditTop();
+}
+exports.editTop = editTop;
+/**
+ * Performs the menu command Edit - Undo, which undoes the previous reversible
+ * operation.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITUNDO.html|www.hcltechsw.com }
+ */
+function editUndo() {
+ return notesc.EditUndo();
+}
+exports.editUndo = editUndo;
+/**
+ * Retrieves the full version of a truncated document.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_UNTRUNCATE.html|www.hcltechsw.com }
+ */
+function editUntruncate() {
+ return notesc.EditUntruncate();
+}
+exports.editUntruncate = editUntruncate;
+/**
+ * Moves the insertion point in a document up by the number of lines you specify.
+ * If you don't specify a number, moves the insertion point up one line.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EDITUP.html|www.hcltechsw.com }
+ */
+function editUp() {
+ return notesc.EditUp();
+}
+exports.editUp = editUp;
+//# sourceMappingURL=edit.js.map
\ No newline at end of file
diff --git a/javadoc/engineering.js.html b/javadoc/engineering.js.html
new file mode 100644
index 00000000..6e7467de
--- /dev/null
+++ b/javadoc/engineering.js.html
@@ -0,0 +1,707 @@
+Source: engineering.js
"use strict";
+/**
+ * @file Engineering
+ * @module engineering
+ * @category Engineering
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.imSub = exports.imSqrt = exports.imSinh = exports.imSin = exports.imSech = exports.imSec = exports.imReal = exports.imProduct = exports.imPower = exports.imLog2 = exports.imLog10 = exports.imLn = exports.imExp = exports.imDiv = exports.imCsch = exports.imCsc = exports.imCot = exports.imCosh = exports.imCos = exports.imConjugate = exports.imArgument = exports.imaginary = exports.imAbs = exports.hex2Oct = exports.hex2Dec = exports.hex2Bin = exports.geStep = exports.erfcPrecise = exports.erfc = exports.erfPrecise = exports.erf = exports.delta = exports.dec2Oct = exports.dec2Hex = exports.dec2Bin = exports.convert = exports.complex = exports.bitXOr = exports.bitRShift = exports.bitOr = exports.bitLShift = exports.bitAnd = exports.bin2Oct = exports.bin2Hex = exports.bin2Dec = exports.besselY = exports.besselK = exports.besselJ = exports.besselI = exports._openFormula = void 0;
+exports.oct2Hex = exports.oct2Dec = exports.oct2Bin = exports.imTan = exports.imSum = void 0;
+const tslib_1 = require("tslib");
+const openf = tslib_1.__importStar(require("../openformula/engineering"));
+exports._openFormula = openf;
+//-----------------------------
+// Open Formula engineering
+/**
+ * Returns the modified Bessel function In(x).
+ * @param {number} x The value at which to evaluate the function
+ * @param {number} order The order of the Bessel function. If order is not an integer, it is truncated
+ * @returns {number} The calculated modified Bessel function for the given value of x and the specified order
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BESSELI|www.oasis-open.org}
+ * @example rosettajs.besselI(2.6, 1) // returns 2.7553843378955585
+ */
+function besselI(x, order) {
+ return openf.BESSELI(x, order);
+}
+exports.besselI = besselI;
+/**
+ * Returns the Bessel function Jn(x).
+ * @param {number} x The value at which to evaluate the function
+ * @param {number} order The order of the Bessel function. If order is not an integer, it is truncated
+ * @returns {number} The calculated Bessel function for the given value of x and the specified order
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BESSELJ|www.oasis-open.org}
+ * @example rosettajs.besselJ(2.6, 1) // returns 0.47081826649775615
+ */
+function besselJ(x, order) {
+ return openf.BESSELJ(x, order);
+}
+exports.besselJ = besselJ;
+/**
+ * Returns the modified Bessel function Kn(x).
+ * @param {number} x The value at which to evaluate the function.
+ * @param {number} order The order of the Bessel function. If order is not an integer, it is truncated
+ * @returns {number} The calculated Bessel function for the given value of x and the specified order
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BESSELK|www.oasis-open.org}
+ * @example rosettajs.besselK(2.6, 1) // returns 0.0652840440474331
+ */
+function besselK(x, order) {
+ return openf.BESSELK(x, order);
+}
+exports.besselK = besselK;
+/**
+ * Returns the Bessel function Yn(x).
+ * @param {number} x The value at which to evaluate the function
+ * @param {number} order The order of the function. If order is not an integer, it is truncated
+ * @returns {number} The calculated Bessel function for the given value of x and the specified order
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BESSELY|www.oasis-open.org}
+ * @example rosettajs.besselY(2.6, 1) // returns 0.18836354378844533
+ */
+function besselY(x, order) {
+ return openf.BESSELY(x, order);
+}
+exports.besselY = besselY;
+/**
+ * Converts a binary number to decimal.
+ * @param {number} number The binary number you want to convert. Number cannot contain more than
+ * 10 characters (10 bits). The most significant bit of number is the sign bit. The
+ * remaining 9 bits are magnitude bits. Negative numbers are represented using
+ * two's-complement notation.
+ * @returns {number} A decimal for the given binary number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BIN2DEC|www.oasis-open.org}
+ * @example rosettajs.bin2Dec(1100001) // returns 97
+ */
+function bin2Dec(number) {
+ return openf.BIN2DEC(number);
+}
+exports.bin2Dec = bin2Dec;
+/**
+ * Converts a binary number to hexadecimal.
+ * @param {number} number The binary number you want to convert. Number cannot contain more than
+ * 10 characters (10 bits). The most significant bit of number is the sign bit. The
+ * remaining 9 bits are magnitude bits. Negative numbers are represented using
+ * two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, bin2Hex uses the
+ * minimum number of characters necessary. Places is useful for padding the return
+ * value with leading 0s (zeros).
+ * @returns {string} A hexadecimal for the given binary number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BIN2HEX|www.oasis-open.org}
+ * @example rosettajs.bin2Hex(11111011) // returns fb
+ * @example rosettajs.bin2Hex(11111011, 4) // returns 00fb
+ */
+function bin2Hex(number, places) {
+ return openf.BIN2HEX(number, places);
+}
+exports.bin2Hex = bin2Hex;
+/**
+ * Converts a binary number to octal.
+ * @param {number} number The binary number you want to convert. Number cannot contain more than
+ * 10 characters (10 bits). The most significant bit of number is the sign bit. The
+ * remaining 9 bits are magnitude bits. Negative numbers are represented using
+ * two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, bin2Oct uses the
+ * minimum number of characters necessary. Places is useful for padding the return
+ * value with leading 0s (zeros).
+ * @returns {string} A octal for the given binary number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BIN2OCT|www.oasis-open.org}
+ * @example rosettajs.bin2Oct(1001) // returns 11
+ * @example rosettajs.bin2Oct(1001, 4) // returns 0011
+ */
+function bin2Oct(number, places) {
+ return openf.BIN2OCT(number, places);
+}
+exports.bin2Oct = bin2Oct;
+/**
+ * Returns a bitwise 'AND' of two numbers.
+ * @param {number} number1 A decimal greater than or equal to 0
+ * @param {number} number2 A decimal greater than or equal to 0
+ * @returns {number} A decimal that is a bitwise 'AND' of the 2 given numbers
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BITAND|www.oasis-open.org}
+ * @example rosettajs.bitAnd(7,29) // returns 5
+ */
+function bitAnd(number1, number2) {
+ return openf.BITAND(number1, number2);
+}
+exports.bitAnd = bitAnd;
+/**
+ * Returns a value number shifted left by shift_amount bits.
+ * @param {number} number A integer greater than or equal to 0
+ * @param {number} shift A integer indicating amount of bits to shift
+ * @returns {number} A decimal representing the specified number shifted left by specified amount of bits
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BITLSHIFT|www.oasis-open.org}
+ * @example rosettajs.bitLShift(5,3) // returns 40
+ */
+function bitLShift(number, shift) {
+ return openf.BITLSHIFT(number, shift);
+}
+exports.bitLShift = bitLShift;
+/**
+ * Returns a bitwise 'OR' of two numbers.
+ * @param {number} number1 A decimal greater than or equal to 0
+ * @param {number} number2 A decimal greater than or equal to 0
+ * @returns {number} A decimal that is a bitwise 'OR' of the 2 given numbers
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BITOR|www.oasis-open.org}
+ * @example rosettajs.bitOr(7,29) // returns 31
+ */
+function bitOr(number1, number2) {
+ return openf.BITOR(number1, number2);
+}
+exports.bitOr = bitOr;
+/**
+ * Returns a value number shifted right by shift_amount bits.
+ * @param {number} number A integer greater than or equal to 0
+ * @param {number} shift A integer indicating amount of bits to shift
+ * @returns {number} A decimal representing the specified number shifted right by specified amount of bits
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BITRSHIFT|www.oasis-open.org}
+ * @example rosettajs.bitRShift(29,2) // returns 7
+ */
+function bitRShift(number, shift) {
+ return openf.BITRSHIFT(number, shift);
+}
+exports.bitRShift = bitRShift;
+/**
+ * Returns a bitwise 'XOR' of two numbers.
+ * @param {number} number1 A decimal greater than or equal to 0
+ * @param {number} number2 A decimal greater than or equal to 0
+ * @returns {number} A decimal that is a bitwise 'XOR' of the 2 given numbers
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#BITXOR|www.oasis-open.org}
+ * @example rosettajs.bitXOr(7,29) // returns 26
+ */
+function bitXOr(number1, number2) {
+ return openf.BITXOR(number1, number2);
+}
+exports.bitXOr = bitXOr;
+/**
+ * Converts real and imaginary coefficients into a complex number.
+ * @param {number} real The real coefficient of the complex number
+ * @param {number} imaginary The imaginary coefficient of the complex number
+ * @param {String} [suffix] The suffix, either lowercase "i" or "j", for the imaginary component of the
+ * complex number. If omitted, suffix is assumed to be "i".
+ * @returns {string|number} A complex number from the given real and imaginary coefficient numbers
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#COMPLEX|www.oasis-open.org}
+ * @example rosettajs.complex(4,5) // returns 4+5i
+ * @example rosettajs.complex(4,5,"j") // returns 4+5j
+ */
+function complex(real, imaginary, suffix = "i") {
+ return openf.COMPLEX(real, imaginary, suffix);
+}
+exports.complex = complex;
+/**
+ * Converts a number from one measurement system to another.
+ * @param {number} number The value in from_units to convert
+ * @param {number} from_unit The units for number
+ * @param {number} to_unit The units for the result
+ * @returns {number} A number representing conversion from one measurement system to another
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#CONVERT|www.oasis-open.org}
+ * @example rosettajs.convert(1, "lbm", "kg") // returns 0.45359237
+ */
+function convert(number, from_unit, to_unit) {
+ return openf.CONVERT(number, from_unit, to_unit);
+}
+exports.convert = convert;
+/**
+ * Converts a decimal number to binary.
+ * @param {number} number The decimal integer you want to convert. If number is negative, valid place
+ * values are ignored and dec2Bin returns a 10-character (10-bit) binary number in
+ * which the most significant bit is the sign bit. The remaining 9 bits are
+ * magnitude bits. Negative numbers are represented using two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, dec2Bin uses the minimum
+ * number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
+ * @returns {number} A binary for the given decimal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DEC2BIN|www.oasis-open.org}
+ * @example rosettajs.dec2Bin(10,5) // returns 01010
+ * @example rosettajs.dec2Bin(-90) // returns 1110100110
+ */
+function dec2Bin(number, places) {
+ return openf.DEC2BIN(number, places);
+}
+exports.dec2Bin = dec2Bin;
+/**
+ * Converts a decimal number to hexadecimal.
+ * @param {number} number The decimal integer you want to convert. If number is negative, places is
+ * ignored and dec2Hex returns a 10-character (40-bit) hexadecimal number in which
+ * the most significant bit is the sign bit. The remaining 39 bits are magnitude
+ * bits. Negative numbers are represented using two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, dec2Hex uses the minimum
+ * number of characters necessary. Places is useful for padding the return value
+ * with leading 0s (zeros).
+ * @returns {string} A hexadecimal for the given decimal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DEC2HEX|www.oasis-open.org}
+ * @example rosettajs.dec2Hex(90, 4) // returns 005a
+ * @example rosettajs.dec2Hex(-75) // returns ffffffffb5
+ */
+function dec2Hex(number, places) {
+ return openf.DEC2HEX(number, places);
+}
+exports.dec2Hex = dec2Hex;
+/**
+ * Converts a decimal number to octal.
+ * @param {number} number The decimal integer you want to convert. If number is negative, places is
+ * ignored and dec2Oct returns a 10-character (30-bit) octal number in which the
+ * most significant bit is the sign bit. The remaining 29 bits are magnitude bits.
+ * Negative numbers are represented using two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, dec2Oct uses the minimum
+ * number of characters necessary. Places is useful for padding the return value
+ * with leading 0s (zeros).
+ * @returns {number} A octal for the given decimal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DEC2OCT|www.oasis-open.org}
+ * @example rosettajs.dec2Oct(78, 3) // returns 116
+ * @example rosettajs.dec2Oct(-75) // returns 7777777665
+ */
+function dec2Oct(number, places) {
+ return openf.DEC2OCT(number, places);
+}
+exports.dec2Oct = dec2Oct;
+/**
+ * Tests whether two values are equal.
+ * @param {number} number1 The first number
+ * @param {number} [number2] The second number. If omitted, number2 is assumed to be zero.
+ * @returns {number} 1 if number1 = number2; returns 0 otherwise
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#DELTA|www.oasis-open.org}
+ * @example rosettajs.delta(6, 4) // returns 0
+ * @example rosettajs.delta(8, 8) // returns 1
+ */
+function delta(number1, number2 = 0) {
+ return openf.DELTA(number1, number2);
+}
+exports.delta = delta;
+/**
+ * Returns the error function integrated between lower_limit and upper_limit.
+ * @param {number} lower_bound The lower bound for integrating ERF
+ * @param {number} [upper_bound] The upper bound for integrating ERF. If omitted, ERF integrates between zero and lower_limit.
+ * @returns {number} The error function integrated between lower_limit and upper_limit
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ERF|www.oasis-open.org}
+ * @example rosettajs.erf(0.875) // returns 0.7840750610598597
+ */
+function erf(lower_bound, upper_bound = 0) {
+ return openf.ERF(lower_bound, upper_bound);
+}
+exports.erf = erf;
+/**
+ * Returns the error function.
+ * @throws {Error} method not implemented
+ * @TODO this needs to be implemented
+ */
+erf.precise = () => {
+ return openf.ERF.PRECISE();
+};
+exports.erfPrecise = erf.precise;
+/**
+ * Returns the complementary error function.
+ * @param {number} x The lower bound for integrating ERFC
+ * @returns {number} Complementary ERF of provided number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ERFC|www.oasis-open.org}
+ * @example rosettajs.erfc(2) // returns 0.004677734981047288
+ */
+function erfc(x) {
+ return openf.ERFC(x);
+}
+exports.erfc = erfc;
+/**
+ * Returns the complementary ERF function integrated between x and infinity.
+ * @throws {Error} method not implemented
+ * @TODO this needs to be implemented
+ */
+erfc.precise = () => {
+ return openf.ERFC.PRECISE();
+};
+exports.erfcPrecise = erfc.precise;
+/**
+ * Tests whether a number is greater than a threshold value.
+ * @param {number} number The value to test against step
+ * @param {number} [step] The threshold value. If you omit a value for step, geStep uses zero.
+ * @returns {number} 1 if number ≥ step; returns 0 (zero) otherwise.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#GESTEP|www.oasis-open.org}
+ * @example rosettajs.geStep(6) // returns 1
+ * @example rosettajs.geStep(6,8) // returns 0
+ */
+function geStep(number, step = 0) {
+ return openf.GESTEP(number, step);
+}
+exports.geStep = geStep;
+/**
+ * Converts a hexadecimal number to binary.
+ * @param {string} number The hexadecimal number you want to convert. Number cannot contain more than 10
+ * characters. The most significant bit of number is the sign bit (40th bit from
+ * the right). The remaining 9 bits are magnitude bits. Negative numbers are
+ * represented using two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, hex2Bin uses the minimum
+ * number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
+ * @returns {string} A binary for the given hexadecimal
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#HEX2BIN|www.oasis-open.org}
+ * @example rosettajs.hex2Bin("B") // returns 1011
+ * @example rosettajs.hex2Bin("B",10) // returns 0000001011
+ */
+function hex2Bin(number, places) {
+ return openf.HEX2BIN(number, places);
+}
+exports.hex2Bin = hex2Bin;
+/**
+ * Converts a hexadecimal number to decimal.
+ * @param {string} number The hexadecimal number you want to convert. Number cannot contain more
+ * than 10 characters (40 bits). The most significant bit of number is the sign
+ * bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using
+ * two's-complement notation.
+ * @returns {number} A decimal for the given hexadecimal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#HEX2DEC|www.oasis-open.org}
+ * @example rosettajs.hex2Dec("A6") // returns 166
+ */
+function hex2Dec(number) {
+ return openf.HEX2DEC(number);
+}
+exports.hex2Dec = hex2Dec;
+/**
+ * Converts a hexadecimal number to octal
+ * @param {string} number The hexadecimal number you want to convert. Number cannot contain more
+ * than 10 characters. The most significant bit of number is the sign bit. The
+ * remaining 39 bits are magnitude bits. Negative numbers are represented using
+ * two's-complement notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, hex2Oct uses the
+ * minimum number of characters necessary. Places is useful for padding the return
+ * value with leading 0s (zeros).
+ * @returns {string} A octal for the given hexadecimal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#HEX2OCT|www.oasis-open.org}
+ * @example rosettajs.hex2Oct("B") // returns 13
+ * @example rosettajs.hex2Oct("B",10) // 0000000013
+ */
+function hex2Oct(number, places) {
+ return openf.HEX2OCT(number, places);
+}
+exports.hex2Oct = hex2Oct;
+/**
+ * Returns the absolute value (modulus) of a complex number.
+ * @param {string|number} inumber A complex number for which you want the absolute value
+ * @returns {number} Absolute value for the given complex number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMABS|www.oasis-open.org}
+ * @example rosettajs.imAbs("9+12i") // returns 15
+ */
+function imAbs(inumber) {
+ return openf.IMABS(inumber);
+}
+exports.imAbs = imAbs;
+/**
+ * Returns the imaginary coefficient of a complex number.
+ * @param {string|number} inumber A complex number for which you want the imaginary coefficient
+ * @returns {string|number} The imaginary coefficient of the given complex number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMAGINARY|www.oasis-open.org}
+ * @example rosettajs.imaginary("4+5i") // returns 5
+ * @example rosettajs.imaginary(7) // returns 0
+ */
+function imaginary(inumber) {
+ return openf.IMAGINARY(inumber);
+}
+exports.imaginary = imaginary;
+/**
+ * Returns the argument theta, an angle expressed in radians.
+ * @param {string|number} inumber A complex number for which you want the argument Theta
+ * @returns {string|number} The argument Theta, an angle expressed in radians, for the given complex number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMARGUMENT|www.oasis-open.org}
+ * @example rosettajs.imArgument("4+5i") // returns 0.8960553845713439
+ */
+function imArgument(inumber) {
+ return openf.IMARGUMENT(inumber);
+}
+exports.imArgument = imArgument;
+/**
+ * Returns the complex conjugate of a complex number.
+ * @param {string|number} inumber A complex number for which you want the conjugate
+ * @returns {string|number} The complex conjugate of the given complex number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMCONJUGATE|www.oasis-open.org}
+ * @example rosettajs.imConjugate("7+4i") // returns 7-4i
+ */
+function imConjugate(inumber) {
+ return openf.IMCONJUGATE(inumber);
+}
+exports.imConjugate = imConjugate;
+/**
+ * Returns the cosine of a complex number.
+ * @param {string|number} inumber A complex number for which you want the cosine
+ * @returns {string|number} Returns the cosine of the given complex number in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMCOS|www.oasis-open.org}
+ * @example rosettajs.imCos("7+i") // returns 1.1633319692207098-0.772091435022302i
+ */
+function imCos(inumber) {
+ return openf.IMCOS(inumber);
+}
+exports.imCos = imCos;
+/**
+ * Returns the hyperbolic cosine of a complex number.
+ * @param {string|number} inumber A complex number for which you want the hyperbolic cosine
+ * @returns {string|number} The hyperbolic cosine of the given complex number in x+yi or x+yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMCOSH|www.oasis-open.org}
+ * @example rosettajs.imCosh("7+i") // returns 296.2569584411429+461.3921082367867i
+ */
+function imCosh(inumber) {
+ return openf.IMCOSH(inumber);
+}
+exports.imCosh = imCosh;
+/**
+ * Returns the cotangent of a complex number.
+ * @param {string|number} inumber A complex number for which you want the cotangent
+ * @returns {string|number} The cotangent of the given complex number in x+yi or x+yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMCOT|www.oasis-open.org}
+ * @example rosettajs.imCot("7+i") // returns 0.27323643702063916-1.0003866917747672i
+ */
+function imCot(inumber) {
+ return openf.IMCOT(inumber);
+}
+exports.imCot = imCot;
+/**
+ * Returns the cosecant of a complex number.
+ * @param {string|number} inumber A complex number for which you want the cosecant
+ * @returns {string|number} The cosecant of a complex number in x+yi or x+yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMCSC|www.oasis-open.org}
+ * @example rosettajs.imCsc("7+i") // returns 0.5592579837285742-0.48875850368917295i
+ */
+function imCsc(inumber) {
+ return openf.IMCSC(inumber);
+}
+exports.imCsc = imCsc;
+/**
+ * Returns the hyperbolic cosecant of a complex number.
+ * @param {string|number} inumber A complex number for which you want the hyperbolic cosecant
+ * @returns {string|number} The hyperbolic cosecant of the given complex number in x+yi or x+yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMCSCH|www.oasis-open.org}
+ * @example rosettajs.imCsch("7+i") // returns 0.0009853823560021253-0.0015346446451764265i
+ */
+function imCsch(inumber) {
+ return openf.IMCSCH(inumber);
+}
+exports.imCsch = imCsch;
+/**
+ * Returns the quotient of two complex numbers.
+ * @param {string|number} inumber1 The complex numerator or dividend
+ * @param {string|number} inumber2 The complex denominator or divisor
+ * @returns {string|number} The quotient of the two given complex numbers in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMDIV|www.oasis-open.org}
+ * @example rosettajs.imDiv("-238+240i","10+24i") // returns 5+12i
+ */
+function imDiv(inumber1, inumber2) {
+ return openf.IMDIV(inumber1, inumber2);
+}
+exports.imDiv = imDiv;
+/**
+ * Returns the exponential of a complex number.
+ * @param {string|number} inumber A complex number for which you want the exponential
+ * @returns {string|number} The exponential of a complex number in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMEXP|www.oasis-open.org}
+ * @example rosettajs.imExp("2+i") // returns 3.992324048441272+6.217676312367968i
+ */
+function imExp(inumber) {
+ return openf.IMEXP(inumber);
+}
+exports.imExp = imExp;
+/**
+ * Returns the natural logarithm of a complex number.
+ * @param {string|number} inumber A complex number for which you want the natural logarithm
+ * @returns {string|number} The natural logarithm of a complex number in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMLN|www.oasis-open.org}
+ * @example rosettajs.imLn("2+i") // returns 0.8047189562170503+0.4636476090008061i
+ */
+function imLn(inumber) {
+ return openf.IMLN(inumber);
+}
+exports.imLn = imLn;
+/**
+ * Returns the base-10 logarithm of a complex number.
+ * @param {string|number} inumber A complex number for which you want the common logarithm
+ * @returns {string|number} The common logarithm (base 10) of a complex number in x + yi or x + yj text format.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMLOG10|www.oasis-open.org}
+ * @example rosettajs.imLog10("7+i") // returns 0.8494850021680093+0.06162510781291279i
+ */
+function imLog10(inumber) {
+ return openf.IMLOG10(inumber);
+}
+exports.imLog10 = imLog10;
+/**
+ * Returns the base-2 logarithm of a complex number.
+ * @param {string|number} inumber A complex number for which you want the base-2 logarithm
+ * @returns {string|number} The base-2 logarithm of a complex number in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMLOG2|www.oasis-open.org}
+ * @example rosettajs.imLog2("7+i") // returns 2.821928094887362+0.20471417699417774i
+ */
+function imLog2(inumber) {
+ return openf.IMLOG2(inumber);
+}
+exports.imLog2 = imLog2;
+/**
+ * Returns a complex number raised to an integer power.
+ * @param {string|number} inumber A complex number you want to raise to a power
+ * @param {number} power The power to which you want to raise the complex number
+ * @returns {string|number} A complex number in x + yi or x + yj text format raised to a power
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMPOWER|www.oasis-open.org}
+ * @example rosettajs.imPower("2+2i", 55) // returns 4.835703278458551e+24-4.835703278458541e+24i
+ */
+function imPower(inumber, power) {
+ return openf.IMPOWER(inumber, power);
+}
+exports.imPower = imPower;
+/**
+ * Returns the product of from 2 to 255 complex numbers.
+ * @param {string[]|number[]} inumbers Inumber1 is required, subsequent inumbers are not. 1 to 255 complex numbers to multiply
+ * @returns {string|number} The product of 1 to 255 complex numbers in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMPRODUCT|www.oasis-open.org}
+ * @example rosettajs.imProduct("7+2i",55) // returns 385+110i
+ * @example rosettajs.imProduct("7+2i","9-3i") // returns 69-3i
+ */
+function imProduct(...inumbers) {
+ return openf.IMPRODUCT(...inumbers);
+}
+exports.imProduct = imProduct;
+/**
+ * Returns the real coefficient of a complex number.
+ * @param {string|number} inumber A complex number for which you want the real coefficient
+ * @returns {string|number} The real coefficient of a complex number in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMREAL|www.oasis-open.org}
+ * @example rosettajs.imReal("7-3i") // returns 7
+ */
+function imReal(inumber) {
+ return openf.IMREAL(inumber);
+}
+exports.imReal = imReal;
+/**
+ * Returns the secant of a complex number.
+ * @param {number} inumber A complex number for which you want the secant
+ * @returns {String} The secant of a complex number in x+yi or x+yj text format.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSEC|www.oasis-open.org}
+ * @example rosettajs.imSec("7-3i") // returns 0.07520380314551633-0.06521210988033882i
+ */
+function imSec(inumber) {
+ return openf.IMSEC(inumber);
+}
+exports.imSec = imSec;
+/**
+ * Returns the hyperbolic secant of a complex number.
+ * @param {number} inumber A complex number for which you want the hyperbolic secant.
+ * @returns {String} The hyperbolic secant of a complex number in x+yi or x+yj text format.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSECH|www.oasis-open.org}
+ * @example rosettajs.imSech("7-3i") // returns -0.0018055112256293788+0.00025736895567555834i
+ */
+function imSech(inumber) {
+ return openf.IMSECH(inumber);
+}
+exports.imSech = imSech;
+/**
+ * Returns the sine of a complex number.
+ * @param {string|number} inumber A complex number for which you want the sine
+ * @returns {string|number} The sine of a complex number in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSIN|www.oasis-open.org}
+ * @example rosettajs.imSin("7-3i") // returns 6.61431901165645-7.552498491503594i
+ */
+function imSin(inumber) {
+ return openf.IMSIN(inumber);
+}
+exports.imSin = imSin;
+/**
+ * Returns the hyperbolic sine of a complex number.
+ * @param {string|number} inumber A complex number for which you want the hyperbolic sine
+ * @returns {string|number} The hyperbolic sine of a complex number in x+yi or x+yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSINH|www.oasis-open.org}
+ * @example rosettajs.imSinh("7-4i") // returns -358.4033361942234+414.96770042530943i
+ */
+function imSinh(inumber) {
+ return openf.IMSINH(inumber);
+}
+exports.imSinh = imSinh;
+/**
+ * Returns the square root of a complex number.
+ * @param {string|number} inumber A complex number for which you want the square root
+ * @returns {string|number} The square root of a complex number in x + yi or x + yj text format.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSQRT|www.oasis-open.org}
+ * @example rosettajs.imSqrt("7-4i") // returns 2.744290231398508-0.7287858904707711i
+ */
+function imSqrt(inumber) {
+ return openf.IMSQRT(inumber);
+}
+exports.imSqrt = imSqrt;
+/**
+ * Returns the difference between two complex numbers.
+ * @param {string|number} inumber1 The complex number from which to subtract inumber2
+ * @param {string|number} inumber2 The complex number to subtract from inumber1
+ * @returns {stirng|number} The difference of two complex numbers in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSUB|www.oasis-open.org}
+ * @example rosettajs.imSub("15+2i","3+3i") // returns 12-1i
+ */
+function imSub(inumber1, inumber2) {
+ return openf.IMSUB(inumber1, inumber2);
+}
+exports.imSub = imSub;
+/**
+ * Returns the sum of complex numbers.
+ * @param {string[]|number[]} inumbers Inumber1 is required, subsequent inumbers are not. 1 to 255 complex numbers to add
+ * @returns {string|number} The sum of two or more complex numbers in x + yi or x + yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMSUM|www.oasis-open.org}
+ * @example rosettajs.imSum("7+2i",55) // returns 755+2i
+ * @example rosettajs.imSum("7+2i","9-3i") // returns 16-1i
+ */
+function imSum(...inumbers) {
+ return openf.IMSUM(...inumbers);
+}
+exports.imSum = imSum;
+/**
+ * Returns the tangent of a complex number.
+ * @param {string|number} inumber A complex number for which you want the tangent
+ * @returns {string|number} The tangent of a complex number in x+yi or x+yj text format
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IMTAN|www.oasis-open.org}
+ * @example rosettajs.imTan("7+2i") // returns 0.03609431359326245+0.9943504089532537i
+ */
+function imTan(inumber) {
+ return openf.IMTAN(inumber);
+}
+exports.imTan = imTan;
+/**
+ * Converts an octal number to binary.
+ * @param {string} number The octal number you want to convert. Number may not contain more than 10
+ * characters. The most significant bit of number is the sign bit. The remaining 29
+ * bits are magnitude bits. Negative numbers are represented using two's-complement
+ * notation.
+ * @param {number} [places] The number of characters to use. If places is omitted, oct2Bin uses the
+ * minimum number of characters necessary. Places is useful for padding the return
+ * value with leading 0s (zeros).
+ * @returns {number} A binary for the given octal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#OCT2BIN|www.oasis-open.org}
+ * @example rosettajs.oct2Bin(7) // returns 111
+ * @example rosettajs.oct2Bin(7, 5) // returns 00111
+ */
+function oct2Bin(number, places) {
+ return openf.OCT2BIN(number, places);
+}
+exports.oct2Bin = oct2Bin;
+/**
+ * Converts an octal number to decimal.
+ * @param {string} number The octal number you want to convert. Number may not contain more than
+ * 10 octal characters (30 bits). The most significant bit of number is the sign
+ * bit. The remaining 29 bits are magnitude bits. Negative numbers are represented
+ * using two's-complement notation.
+ * @returns {number} A decimal for the given octal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#OCT2DEC|www.oasis-open.org}
+ * @example rosettajs.oct2Dec(64) // returns 52
+ */
+function oct2Dec(number) {
+ return openf.OCT2DEC(number);
+}
+exports.oct2Dec = oct2Dec;
+/**
+ * Converts an octal number to hexadecimal.
+ * @param {string} number The octal number you want to convert. Number may not contain more than
+ * 10 octal characters (30 bits). The most significant bit of number is the sign
+ * bit. The remaining 29 bits are magnitude bits. Negative numbers are represented
+ * using two's-complement notation
+ * @param {number} [places] The number of characters to use. If places is omitted, OCT2HEX uses the
+ * minimum number of characters necessary. Places is useful for padding the return
+ * value with leading 0s (zeros).
+ * @returns {number} A hexadecimal for the given octal number
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#OCT2HEX|www.oasis-open.org}
+ * @example rosettajs.oct2Hex(177747533) // returns 1ffcf5b
+ * @example rosettajs.oct2Hex(74,5) // returns 0003c
+ */
+function oct2Hex(number, places) {
+ return openf.OCT2HEX(number, places);
+}
+exports.oct2Hex = oct2Hex;
+//-----------------------------
+// Notes @functions engineering
+//-----------------------------
+// Notes @Commands engineering
+//# sourceMappingURL=engineering.js.map
\ No newline at end of file
diff --git a/javadoc/file.js.html b/javadoc/file.js.html
new file mode 100644
index 00000000..ac6d356b
--- /dev/null
+++ b/javadoc/file.js.html
@@ -0,0 +1,257 @@
+Source: file.js
"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileSaveNewVersion = exports.filePrintSetup = exports.filePageSetup = exports.fileOpenDBRepID = exports.fileNewReplica = exports.fileNewDatabase = exports.fileImport = exports.fileFullTextUpdate = exports.fileFullTextInfo = exports.fileFullTextDelete = exports.fileFullTextCreate = exports.fileExport = exports.fileExit = exports.fileDatabaseUseServer = exports.fileDatabaseRemove = exports.fileDatabaseInfo = exports.fileDatabaseDelete = exports.fileDatabaseCopy = exports.fileDatabaseCompact = exports.fileDatabaseACL = exports.fileSave = exports.filePrint = exports.fileOpenDatabase = exports.fileCloseWindow = exports._notes_vmx = exports._notes = void 0;
+const tslib_1 = require("tslib");
+/**
+ * @file File
+ * @module file
+ * @category File
+ */
+const notesc_base = tslib_1.__importStar(require("../notes/file"));
+const notesc_vmx = tslib_1.__importStar(require("../notes/voltmx/file"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const notesc = () => API.isDefaultFrameworkVoltMX() ? notesc_vmx : notesc_base;
+exports._notes = notesc_base;
+exports._notes_vmx = notesc_vmx;
+/**
+ * Closes the current Notes® window. If the document or design element in that
+ * window has not been saved, Notes® prompts the user to save it before closing.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILECLOSEWINDOW.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+const fileCloseWindow = () => {
+ return notesc().FileCloseWindow();
+};
+exports.fileCloseWindow = fileCloseWindow;
+/**
+ * Opens the specified database to the specified view, highlighting the first
+ * document whose value in the sort column matches the key. You specify a database
+ * using its server and file name.
+ * @param {any} serverDatabase
+ * @param {string} viewName
+ * @param {any} key
+ * @returns {Promise<boolean>}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEOPENDATABASE.html|www.hcltechsw.com }
+ */
+const fileOpenDatabase = (serverDatabase, viewName, key) => {
+ return notesc().FileOpenDatabase(serverDatabase, viewName, key);
+};
+exports.fileOpenDatabase = fileOpenDatabase;
+/**
+ * Prints the currently open or selected document(s), or the current view.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEPRINT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+const filePrint = () => {
+ return notesc().FilePrint();
+};
+exports.filePrint = filePrint;
+/**
+ * Performs the menu command File - Save.
+ * @returns {Promise<boolean>}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILESAVE.html|www.hcltechsw.com }
+ */
+const fileSave = () => {
+ return notesc().FileSave();
+};
+exports.fileSave = fileSave;
+/**
+ * Displays the access control list for the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASEACL.html|www.hcltechsw.com }
+ */
+const fileDatabaseACL = () => {
+ return notesc().FileDatabaseACL();
+};
+exports.fileDatabaseACL = fileDatabaseACL;
+/**
+ * Compacts the white space in a database, and at the same time, converts the old
+ * database to the new format.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASECOMPACT.html|www.hcltechsw.com }
+ */
+const fileDatabaseCompact = () => {
+ return notesc().FileDatabaseCompact();
+};
+exports.fileDatabaseCompact = fileDatabaseCompact;
+/**
+ * Displays the Copy Database dialog box, where the user can copy the current
+ * database to a new location.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASECOPY.html|www.hcltechsw.com }
+ */
+const fileDatabaseCopy = () => {
+ return notesc().FileDatabaseCopy();
+};
+exports.fileDatabaseCopy = fileDatabaseCopy;
+/**
+ * Permanently deletes the current database file from the hard disk where it is
+ * stored.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASEDELETE.html|www.hcltechsw.com }
+ */
+const fileDatabaseDelete = () => {
+ return notesc().FileDatabaseDelete();
+};
+exports.fileDatabaseDelete = fileDatabaseDelete;
+/**
+ * Displays the Properties box for the current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASEINFO.html|www.hcltechsw.com }
+ */
+const fileDatabaseInfo = () => {
+ return notesc().FileDatabaseInfo();
+};
+exports.fileDatabaseInfo = fileDatabaseInfo;
+/**
+ * Removes the current database icon from the workspace.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASEREMOVE.html|www.hcltechsw.com }
+ */
+const fileDatabaseRemove = () => {
+ return notesc().FileDatabaseRemove();
+};
+exports.fileDatabaseRemove = fileDatabaseRemove;
+/**
+ * Displays the Switch Servers dialog box, where the user can choose a server that
+ * contains a replica of the currently selected database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEDATABASEUSESERVER.html|www.hcltechsw.com }
+ */
+const fileDatabaseUseServer = () => {
+ return notesc().FileDatabaseUseServer();
+};
+exports.fileDatabaseUseServer = fileDatabaseUseServer;
+/**
+ * Performs the menu command File - Exit (File - Quit on the Macintosh), which
+ * closes Notes/Domino and all its open windows.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEEXIT.html|www.hcltechsw.com }
+ */
+const fileExit = () => {
+ return notesc().FileExit();
+};
+exports.fileExit = fileExit;
+/**
+ * Exports a Notes/Domino document or view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEEXPORT.html|www.hcltechsw.com }
+ */
+const fileExport = () => {
+ return notesc().FileExport();
+};
+exports.fileExport = fileExport;
+/**
+ * Displays the Full-Text Create Index dialog box, where the user can specify
+ * settings for the database's full-text index.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEFULLTEXTCREATE.html|www.hcltechsw.com }
+ */
+const fileFullTextCreate = () => {
+ return notesc().FileFullTextCreate();
+};
+exports.fileFullTextCreate = fileFullTextCreate;
+/**
+ * Deletes a database's full-text index.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEFULLTEXTDELETE.html|www.hcltechsw.com }
+ */
+const fileFullTextDelete = () => {
+ return notesc().FileFullTextDelete();
+};
+exports.fileFullTextDelete = fileFullTextDelete;
+/**
+ * Displays the Full Text tab of the current database's Properties box.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEFULLTEXTINFO.html|www.hcltechsw.com }
+ */
+const fileFullTextInfo = () => {
+ return notesc().FileFullTextInfo();
+};
+exports.fileFullTextInfo = fileFullTextInfo;
+/**
+ * Updates full-text indexes for local databases or queues the update request for
+ * server-based databases.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEFULLTEXTUPDATE.html|www.hcltechsw.com }
+ */
+const fileFullTextUpdate = () => {
+ return notesc().FileFullTextUpdate();
+};
+exports.fileFullTextUpdate = fileFullTextUpdate;
+/**
+ * Imports a file into a Notes/Domino document or view.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEIMPORT.html|www.hcltechsw.com }
+ */
+const fileImport = () => {
+ return notesc().FileImport();
+};
+exports.fileImport = fileImport;
+/**
+ * Displays the New Database dialog box, where the user can select a server, title,
+ * and file name for a new database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILENEWDATABASE.html|www.hcltechsw.com }
+ */
+const fileNewDatabase = () => {
+ return notesc().FileNewDatabase();
+};
+exports.fileNewDatabase = fileNewDatabase;
+/**
+ * Displays the New Replica dialog box, where the user can create a replica of the
+ * current database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILENEWREPLICA.html|www.hcltechsw.com }
+ */
+const fileNewReplica = () => {
+ return notesc().FileNewReplica();
+};
+exports.fileNewReplica = fileNewReplica;
+/**
+ * Opens the specified database to the specified view, highlighting the first
+ * document whose value in the sort column matches the key. You specify a database
+ * using its replica ID, and Notes/Domino searches the workspace and all servers
+ * available in the current session to find a replica.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEOPENDBREPID.html|www.hcltechsw.com }
+ */
+const fileOpenDBRepID = () => {
+ return notesc().FileOpenDBRepID();
+};
+exports.fileOpenDBRepID = fileOpenDBRepID;
+/**
+ * Displays the Page Setup dialog box (or, on the Macintosh, the File Print Margins
+ * dialog box), which allows you to specify print settings for the selected
+ * database.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEPAGESETUP.html|www.hcltechsw.com }
+ */
+const filePageSetup = () => {
+ return notesc().FilePageSetup();
+};
+exports.filePageSetup = filePageSetup;
+/**
+ * Displays the Print Setup dialog box, which allows you to direct the current view
+ * or document to a printer or a file that you specify.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILEPRINTSETUP.html|www.hcltechsw.com }
+ */
+const filePrintSetup = () => {
+ return notesc().FilePrintSetup();
+};
+exports.filePrintSetup = filePrintSetup;
+/**
+ * Saves a document as a new version.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FILESAVENEWVERSION.html|www.hcltechsw.com }
+ */
+const fileSaveNewVersion = () => {
+ return notesc().FileSaveNewVersion();
+};
+exports.fileSaveNewVersion = fileSaveNewVersion;
+//# sourceMappingURL=file.js.map
\ No newline at end of file
diff --git a/javadoc/financial.js.html b/javadoc/financial.js.html
new file mode 100644
index 00000000..518a4733
--- /dev/null
+++ b/javadoc/financial.js.html
@@ -0,0 +1,929 @@
+Source: financial.js
"use strict";
+/**
+ * @file Financial
+ * @module financial
+ * @category Financial
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tbillYield = exports.tbillPrice = exports.tbillEq = exports.syd = exports.sln = exports.rri = exports.received = exports.rate = exports.pv = exports.priceMat = exports.priceDisc = exports.price = exports.pPmt = exports.pmt = exports.pDuration = exports.oddLYield = exports.oddLPrice = exports.oddFYield = exports.oddFPrice = exports.npv = exports.nPer = exports.nominal = exports.mirr = exports.mDuration = exports.isPmt = exports.irr = exports.iPmt = exports.intRate = exports.fvSchedule = exports.fv = exports.effect = exports.duration = exports.dollarFr = exports.dollarDe = exports.disc = exports.ddb = exports.db = exports.cumPrinc = exports.cumIPmt = exports.coupPCD = exports.coupNum = exports.coupNCD = exports.coupDaySnc = exports.coupDays = exports.coupDayBS = exports.amorLinc = exports.amorDegrc = exports.accrIntM = exports.accrInt = exports._openFormula = void 0;
+exports.yieldMat = exports.yieldDisc = exports.Yield = exports.xnpv = exports.xirr = exports.vdb = void 0;
+const tslib_1 = require("tslib");
+const openf = tslib_1.__importStar(require("../openformula/financial"));
+exports._openFormula = openf;
+//-----------------------------
+// Open Formula financial
+/**
+ * Returns the modified Bessel function In(x).
+ * @param {Date} issue The security's issue date.
+ * @param {Date} first_interest The security's first interest date.
+ * @param {Date} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {number} rate The security's annual coupon rate.
+ * @param {number} par The security's par value. If you omit par, ACCRINT uses $1,000.
+ * @param {number} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {number} [basis] Optional. The type of day count basis to use.
+ * @returns {number} returns error if inputs are invalid, otherwise returns the accrued interest as a number.
+ */
+function accrInt(issue, first_interest, settlement, rate, par, frequency, basis) {
+ return openf.ACCRINT(issue, first_interest, settlement, rate, par, frequency, basis);
+}
+exports.accrInt = accrInt;
+/**
+ *
+ * Returns the accrued interest for a security that pays interest at maturity.
+ *
+ * Category: Financial
+ *
+ * @param {*} issue The security's issue date.
+ * @param {*} settlement The security's maturity date.
+ * @param {*} rate The security's annual coupon rate.
+ * @param {*} par The security's par value. If you omit par, ACCRINTM uses $1,000.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function accrIntM() {
+ return openf.ACCRINTM();
+}
+exports.accrIntM = accrIntM;
+/**
+ * Returns the depreciation for each accounting period by using a depreciation coefficient.
+ *
+ * Category: Financial
+ *
+ * @param {*} cost The cost of the asset.
+ * @param {*} date_purchased The date of the purchase of the asset.
+ * @param {*} first_period The date of the end of the first period.
+ * @param {*} salvage The salvage value at the end of the life of the asset.
+ * @param {*} period The period.
+ * @param {*} rate The rate of depreciation.
+ * @param {*} basis Optional. The year basis to be used.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function amorDegrc() {
+ return openf.AMORDEGRC();
+}
+exports.amorDegrc = amorDegrc;
+/**
+ * Returns the depreciation for each accounting period.
+ *
+ * Category: Financial
+ *
+ * @param {*} cost The cost of the asset.
+ * @param {*} date_purchased The date of the purchase of the asset.
+ * @param {*} first_period The date of the end of the first period.
+ * @param {*} salvage The salvage value at the end of the life of the asset.
+ * @param {*} period The period.
+ * @param {*} rate The rate of depreciation.
+ * @param {*} basis Optional. The year basis to be used.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function amorLinc() {
+ return openf.AMORLINC();
+}
+exports.amorLinc = amorLinc;
+/**
+ * Returns the number of days from the beginning of the coupon period to the settlement date.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function coupDayBS() {
+ return openf.COUPDAYBS();
+}
+exports.coupDayBS = coupDayBS;
+/**
+ * Returns the number of days in the coupon period that contains the settlement date.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function coupDays() {
+ return openf.COUPDAYS();
+}
+exports.coupDays = coupDays;
+/**
+ * Returns the number of days from the settlement date to the next coupon date.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function coupDaySnc() {
+ return openf.COUPDAYSNC();
+}
+exports.coupDaySnc = coupDaySnc;
+/**
+ * Returns the next coupon date after the settlement date.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function coupNCD() {
+ return openf.COUPNCD();
+}
+exports.coupNCD = coupNCD;
+/**
+ * Returns the number of coupons payable between the settlement date and maturity date.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented
+ */
+function coupNum() {
+ return openf.COUPNUM();
+}
+exports.coupNum = coupNum;
+/**
+ * Returns the previous coupon date before the settlement date.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented
+ */
+function coupPCD() {
+ return openf.COUPPCD();
+}
+exports.coupPCD = coupPCD;
+/**
+ * Returns the cumulative interest paid between two periods.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate.
+ * @param {number} numper The total number of payment periods.
+ * @param {number} pvalue The present value.
+ * @param {number} start_period The first period in the calculation. Payment periods are numbered beginning with 1.
+ * @param {number} end_period The last period in the calculation.
+ * @param {number} type The timing of the payment.
+ * @returns {number} the cumulative interest paid between two periods or an error if the arguments are incorrect.
+ */
+function cumIPmt(intrate, numper, pvalue, start_period, end_period, type) {
+ return openf.CUMIPMT(intrate, numper, pvalue, start_period, end_period, type);
+}
+exports.cumIPmt = cumIPmt;
+/**
+ * Returns the cumulative principal paid on a loan between two periods.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate.
+ * @param {number} numper The total number of payment periods.
+ * @param {number} pvalue The present value.
+ * @param {number} start_period The first period in the calculation. Payment periods are numbered beginning with 1.
+ * @param {number} end_period The last period in the calculation.
+ * @param {number} type The timing of the payment.
+ * @returns {number} returns an error if input is wrong, otherwise returns cumulative principle as a number
+ */
+function cumPrinc(intrate, numper, pvalue, start_period, end_period, type) {
+ return openf.CUMPRINC(intrate, numper, pvalue, start_period, end_period, type);
+}
+exports.cumPrinc = cumPrinc;
+/**
+ * Returns the depreciation of an asset for a specified period by using the fixed-declining balance method.
+ *
+ * Category: Financial
+ *
+ * @param {number} initcost The initial cost of the asset.
+ * @param {number} salvageval The value at the end of the depreciation (sometimes called the salvage value of the asset).
+ * @param {number} uselife The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
+ * @param {number} depperiod The period for which you want to calculate the depreciation. Period must use the same units as life.
+ * @param {number} [months] Optional. The number of months in the first year. If month is omitted, it is assumed to be 12.
+ * @returns {number} returns the depreciation as a number or an error if the arguments are incorrect.
+ */
+function db(initcost, salvageval, uselife, depperiod, months = 12) {
+ return openf.DB(initcost, salvageval, uselife, depperiod, months);
+}
+exports.db = db;
+/**
+ * Returns the depreciation of an asset for a specified period by using the double-declining balance method or some other method that you specify.
+ *
+ * Category: Financial
+ *
+ * @param {number} initcost The initial cost of the asset.
+ * @param {number} salvageval The value at the end of the depreciation (sometimes called the salvage value of the asset). This value can be 0.
+ * @param {number} uselife The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
+ * @param {number} depperiod The period for which you want to calculate the depreciation. Period must use the same units as life.
+ * @param {number} [decfactor] Optional. The rate at which the balance declines. If factor is omitted, it is assumed to be 2 (the double-declining balance method).
+ * @returns {number} the depreciation of an asset for a specified period using fixed double declining balance or an error if the arguments are not formatted properly.
+ */
+function ddb(initcost, salvageval, uselife, depperiod, decfactor) {
+ return openf.DDB(initcost, salvageval, uselife, depperiod, decfactor);
+}
+exports.ddb = ddb;
+/**
+ * Returns the discount rate for a security.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} pr The security's price per $100 face value.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented
+ */
+function disc() {
+ return openf.DISC();
+}
+exports.disc = disc;
+/**
+ * Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.
+ *
+ * Category: Financial
+ *
+ * @param {number} fractional_dollar A number expressed as an integer part and a fraction part, separated by a decimal symbol.
+ * @param {number} fraction The integer to use in the denominator of the fraction.
+ * @returns {number} a decimal number that results from converting a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. Or an error if the arguments are not formatted properly.
+ */
+function dollarDe(fractional_dollar, fraction) {
+ return openf.DOLLARDE(fractional_dollar, fraction);
+}
+exports.dollarDe = dollarDe;
+/**
+ * Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.
+ *
+ * Category: Financial
+ *
+ * @param {number} decimal_dollar A decimal number.
+ * @param {number} fraction The integer to use in the denominator of a fraction.
+ * @returns {number} a fraction that results from converting dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. Or an error if he arguments arent formatted properly.
+ */
+function dollarFr(decimal_dollar, fraction) {
+ return openf.DOLLARFR(decimal_dollar, fraction);
+}
+exports.dollarFr = dollarFr;
+/**
+ * Returns the annual duration of a security with periodic interest payments.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} coupon The security's annual coupon rate.
+ * @param {*} yld The security's annual yield.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented
+ */
+function duration() {
+ return openf.DURATION();
+}
+exports.duration = duration;
+/**
+ * Returns the effective annual interest rate.
+ *
+ * Category: Financial
+ *
+ * @param {number} nominal_intrate The nominal interest rate.
+ * @param {number} nperyr The number of compounding periods per year.
+ * @returns {number} effective annual interest rate or an error if the arguments are not formated properly.
+ */
+function effect(nominal_intrate, nperyr) {
+ return openf.EFFECT(nominal_intrate, nperyr);
+}
+exports.effect = effect;
+/**
+ * Returns the future value of an investment.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate per period.
+ * @param {number} numper The total number of payment periods in an annuity.
+ * @param {number} pmt The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. If pmt is omitted, you must include the pv argument.
+ * @param {number} [pv] Optional. The present value, or the lump-sum amount that a series of future payments is worth right now. If pv is omitted, it is assumed to be 0 (zero), and you must include the pmt argument.
+ * @param {number} [type] Optional. The number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
+ * @returns {number} the future value of an investment or an error if the arguments are not formatted properly.
+ */
+function fv(intrate, numper, pmt, pv = 0, type = 0) {
+ return openf.FV(intrate, numper, pmt, pv, type);
+}
+exports.fv = fv;
+/**
+ * Returns the future value of an initial principal after applying a series of compound interest rates.
+ *
+ * Category: Financial
+ *
+ * @param {number} principal The present value.
+ * @param {number} schedule An array of interest rates to apply.
+ * @returns {number} the future value of an initial principal after applying a series of compound interest rates or an error if arguments are formatted improperly.
+ */
+function fvSchedule(principal, schedule) {
+ return openf.FVSCHEDULE(principal, schedule);
+}
+exports.fvSchedule = fvSchedule;
+/**
+ * Returns the interest rate for a fully invested security.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} investment The amount invested in the security.
+ * @param {*} redemption The amount to be received at maturity.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function intRate() {
+ return openf.INTRATE();
+}
+exports.intRate = intRate;
+/**
+ * Returns the interest payment for an investment for a given period.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate per period.
+ * @param {number} period The period for which you want to find the interest and must be in the range 1 to nper.
+ * @param {number} numper The total number of payment periods in an annuity.
+ * @param {number} pvalue The present value, or the lump-sum amount that a series of future payments is worth right now.
+ * @param {number} [fvalue] Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).
+ * @param {number} [type] Optional. The number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
+ * @returns {number} the interest payment for an investment for a given period or an error if the arguments are not formatted properly.
+ */
+function iPmt(intrate, period, numper, pvalue, fvalue = 0, type = 0) {
+ return openf.IPMT(intrate, period, numper, pvalue, fvalue, type);
+}
+exports.iPmt = iPmt;
+/**
+ * Returns the internal rate of return for a series of cash flows.
+ *
+ * Category: Financial
+ *
+ * @param {any[]} values An array or a reference to values that contain numbers for which you want to calculate the internal rate of return.
+ - Values must contain at least one positive value and one negative value to calculate the internal rate of return.
+ - IRR uses the order of values to interpret the order of cash flows. Be sure to enter your payment and income values in the sequence you want.
+ - If an array or reference argument contains text, logical values, or empty values, those values are ignored.
+ * @param {number} [guess] Optional. A number that you guess is close to the result of IRR.
+ - Microsoft Excel uses an iterative technique for calculating IRR. Starting with guess, IRR cycles through the calculation until the result is accurate within 0.00001 percent. If IRR can't find a result that works after 20 tries, the #NUM! error value is returned.
+ - In most cases you do not need to provide guess for the IRR calculation. If guess is omitted, it is assumed to be 0.1 (10 percent).
+ - If IRR gives the #NUM! error value, or if the result is not close to what you expected, try again with a different value for guess.
+ * @returns {number} the internal rate of return for a series of cash flows or an error if the arguments are incorrect.
+ */
+function irr(values, guess = 0.1) {
+ return openf.IRR(values, guess);
+}
+exports.irr = irr;
+/**
+ * Calculates the interest paid during a specific period of an investment.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate for the investment.
+ * @param {number} period The period for which you want to find the interest, and must be between 1 and Nper.
+ * @param {number} numper The total number of payment periods for the investment.
+ * @param {number} pvalue The present value of the investment. For a loan, Pv is the loan amount.
+ *
+ * @returns {number} the interest paid during a specific period of an investment or an error if the arguments are incorrect.
+ */
+function isPmt(intrate, period, numper, pvalue) {
+ return openf.ISPMT(intrate, period, numper, pvalue);
+}
+exports.isPmt = isPmt;
+/**
+ * Returns the Macauley modified duration for a security with an assumed par value of $100.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} coupon The security's annual coupon rate.
+ * @param {*} yld The security's annual yield.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function mDuration() {
+ return openf.MDURATION();
+}
+exports.mDuration = mDuration;
+/**
+ * Returns the internal rate of return where positive and negative cash flows are financed at different rates.
+ *
+ * Category: Financial
+ *
+ * @param {any[]} values An array or a reference to values that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.
+ - Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.
+ - If an array or reference argument contains text, logical values, or empty values, those values are ignored; however, values with the value zero are included.
+ * @param {number} finance_intrate The interest rate you pay on the money used in the cash flows.
+ * @param {number} reinvest_intrate The interest rate you receive on the cash flows as you reinvest them.
+ * @returns {number} the internal rate of return where positive and negative cash flows are financed at different rates or an error when the arguments arent formatted properly.
+ */
+function mirr(values, finance_intrate, reinvest_intrate) {
+ return openf.MIRR(values, finance_intrate, reinvest_intrate);
+}
+exports.mirr = mirr;
+/**
+ * Returns the annual nominal interest rate.
+ *
+ * Category: Financial
+ *
+ * @param {number} effect_intrate The effective interest rate.
+ * @param {number} numpery The number of compounding periods per year.
+ * @returns {number} the annual nominal interest rate or an error if the arguments arent formatted properly
+ */
+function nominal(effect_intrate, numpery) {
+ return openf.NOMINAL(effect_intrate, numpery);
+}
+exports.nominal = nominal;
+/**
+ * Returns the number of periods for an investment.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate per period.
+ * @param {number} payment The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes.
+ * @param {number} pvalue The present value, or the lump-sum amount that a series of future payments is worth right now.
+ * @param {number} [fvalue] Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).
+ * @param {number} [type] Optional. The number 0 or 1 and indicates when payments are due.
+ * @returns {number} the number of periods for an invesment or an error if the arguments are not formatted properly.
+ */
+function nPer(intrate, payment, pvalue, fvalue = 0, type = 0) {
+ return openf.NPER(intrate, payment, pvalue, fvalue, type);
+}
+exports.nPer = nPer;
+/**
+ * Returns the net present value of an investment based on a series of periodic cash flows and a discount rate.
+ *
+ * Category: Financial
+ *
+ * @param {number} drate The rate of discount over the length of one period.
+ * @param {number[]} values value1, value2, ... Value1 is required, subsequent values are optional. 1 to 254 arguments representing the payments and income.
+ - value1, value2, ... must be equally spaced in time and occur at the end of each period.
+ - NPV uses the order of value1, value2, ... to interpret the order of cash flows. Be sure to enter your payment and income values in the correct sequence.
+ - Arguments that are empty values, logical values, or text representations of numbers, error values, or text that cannot be translated into numbers are ignored.
+ - If an argument is an array or reference, only numbers in that array or reference are counted. Empty values, logical values, text, or error values in the array or reference are ignored.
+ * @returns {number} net present value as a number or an error if the arguments dont match requirements.
+ */
+function npv(drate, ...values) {
+ return openf.NPV(drate, ...values);
+}
+exports.npv = npv;
+/**
+ * Returns the price per $100 face value of a security with an odd first period.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} issue The security's issue date.
+ * @param {*} first_coupon The security's first coupon date.
+ * @param {*} rate The security's interest rate.
+ * @param {*} yld The security's annual yield.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function oddFPrice() {
+ return openf.ODDFPRICE();
+}
+exports.oddFPrice = oddFPrice;
+/**
+ * Returns the yield of a security with an odd first period.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} issue The security's issue date.
+ * @param {*} first_coupon The security's first coupon date.
+ * @param {*} rate The security's interest rate.
+ * @param {*} pr The security's price.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function oddFYield() {
+ return openf.ODDFYIELD();
+}
+exports.oddFYield = oddFYield;
+/**
+ * Returns the price per $100 face value of a security with an odd last period.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} last_interest The security's last coupon date.
+ * @param {*} rate The security's interest rate.
+ * @param {*} yld The security's annual yield.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function oddLPrice() {
+ return openf.ODDLPRICE();
+}
+exports.oddLPrice = oddLPrice;
+/**
+ * Returns the yield of a security with an odd last period.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} last_interest The security's last coupon date.
+ * @param {*} rate The security's interest rate
+ * @param {*} pr The security's price.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function oddLYield() {
+ return openf.ODDLYIELD();
+}
+exports.oddLYield = oddLYield;
+/**
+ * Returns the number of periods required by an investment to reach a specified value.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate Rate is the interest rate per period.
+ * @param {number} pvalue Pv is the present value of the investment.
+ * @param {number} fvalue Fv is the desired future value of the investment.
+ * @returns {number} the number of periods required as a number or an error if arguments are not formatted properly.
+ */
+function pDuration(intrate, pvalue, fvalue) {
+ return openf.PDURATION(intrate, pvalue, fvalue);
+}
+exports.pDuration = pDuration;
+/**
+ * Returns the periodic payment for an annuity.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate for the loan.
+ * @param {number} numper The total number of payments for the loan.
+ * @param {number} pvalue The present value, or the total amount that a series of future payments is worth now; also known as the principal.
+ * @param {number} [fvalue] Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
+ * @param {number} [type] Optional. The number 0 (zero) or 1 and indicates when payments are due.
+ * @returns {number} the periodic payment for an annuity as a number or error if the arguments are not formatted properly.
+
+ */
+function pmt(intrate, numper, pvalue, fvalue = 0, type = 0) {
+ return openf.PMT(intrate, numper, pvalue, fvalue, type);
+}
+exports.pmt = pmt;
+/**
+ * Returns the payment on the principal for an investment for a given period.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate per period.
+ * @param {number} period Specifies the period and must be in the range 1 to nper.
+ * @param {number} numper The total number of payment periods in an annuity.
+ * @param {number} pvalue The present value — the total amount that a series of future payments is worth now.
+ * @param {number} [fvalue] Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
+ * @param {number} [type] Optional. The number 0 or 1 and indicates when payments are due.
+ * @returns {number} principal payment for investment over a specific period as a number, or an error if the arguments are not formated properly.
+ */
+function pPmt(intrate, period, numper, pvalue, fvalue = 0, type = 0) {
+ return openf.PPMT(intrate, period, numper, pvalue, fvalue, type);
+}
+exports.pPmt = pPmt;
+/**
+ * Returns the price per $100 face value of a security that pays periodic interest.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} rate The security's annual coupon rate.
+ * @param {*} yld The security's annual yield.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function price() {
+ return openf.PRICE();
+}
+exports.price = price;
+/**
+ * Returns the price per $100 face value of a discounted security.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} discount The security's discount rate.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function priceDisc() {
+ return openf.PRICEDISC();
+}
+exports.priceDisc = priceDisc;
+/**
+ * Returns the price per $100 face value of a security that pays interest at maturity.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} issue The security's issue date, expressed as a serial date number.
+ * @param {*} rate The security's interest rate at date of issue.
+ * @param {*} yld The security's annual yield.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function priceMat() {
+ return openf.PRICEMAT();
+}
+exports.priceMat = priceMat;
+/**
+ * Returns the present value of an investment.
+ *
+ * Category: Financial
+ *
+ * @param {number} intrate The interest rate per period. For example, if you obtain an automobile loan at a 10 percent annual interest rate and make monthly payments, your interest rate per month is 10%/12, or 0.83%. You would enter 10%/12, or 0.83%, or 0.0083, into the formula as the rate.
+ * @param {number} periods The total number of payment periods in an annuity. For example, if you get a four-year car loan and make monthly payments, your loan has 4*12 (or 48) periods. You would enter 48 into the formula for nper.
+ * @param {number} payment The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes. For example, the monthly payments on a $10,000, four-year car loan at 12 percent are $263.33. You would enter -263.33 into the formula as the pmt. If pmt is omitted, you must include the fv argument.
+ * @param {number} fvalue Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0). For example, if you want to save $50,000 to pay for a special project in 18 years, then $50,000 is the future value. You could then make a conservative guess at an interest rate and determine how much you must save each month. If fv is omitted, you must include the pmt argument.
+ * @param {number} [type] Optional. The number 0 or 1 and indicates when payments are due.
+ * @returns {number} present value of an investment or an error if arguments are not formatted properly.
+ */
+function pv(intrate, periods, payment, fvalue = 0, type = 0) {
+ return openf.PV(intrate, periods, payment, fvalue, type);
+}
+exports.pv = pv;
+/**
+ * Returns the interest rate per period of an annuity.
+ *
+ * Category: Financial
+ *
+ * @param {number} periods The total number of payment periods in an annuity.
+ * @param {number} payment The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes. If pmt is omitted, you must include the fv argument.
+ * @param {number} pvalue The present value — the total amount that a series of future payments is worth now.
+ * @param {number} [fvalue] Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0). If fv is omitted, you must include the pmt argument.
+ * @param {number} [type] Optional. The number 0 or 1 and indicates when payments are due.
+ * @param {number} [guess] Optional. Your guess for what the rate will be. If you omit guess, it is assumed to be 10 percent. If RATE does not converge, try different values for guess. RATE usually converges if guess is between 0 and 1.
+ - If you omit guess, it is assumed to be 10 percent.
+ - If RATE does not converge, try different values for guess. RATE usually converges if guess is between 0 and 1.
+ * @returns {number} the interest rate per period of an annuity or an error if the arguments arent formatted properly.
+ */
+function rate(periods, payment, pvalue, fvalue = 0, paytype = 0, guess = 0.01) {
+ return openf.RATE(periods, payment, pvalue, fvalue, paytype, guess);
+}
+exports.rate = rate;
+/**
+ * Returns the amount received at maturity for a fully invested security.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} investment The amount invested in the security.
+ * @param {*} discount The security's discount rate.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function received() {
+ return openf.RECEIVED();
+}
+exports.received = received;
+/**
+ * Returns an equivalent interest rate for the growth of an investment.
+ *
+ * Category: Financial
+ *
+ * @param {number} periods The number of periods for the investment.
+ * @param {number} pvalue The present value of the investment.
+ * @param {number} fvalue The future value of the investment.
+ * @returns {number} an equivalent interestrate for growth of an investment or an error if arguments are not formatted properly.
+ */
+function rri(periods, pvalue, fvalue) {
+ return openf.RRI(periods, pvalue, fvalue);
+}
+exports.rri = rri;
+/**
+ * Returns the straight-line depreciation of an asset for one period.
+ *
+ * Category: Financial
+ *
+ * @param {number} initcost The initial cost of the asset.
+ * @param {number} salvageval The value at the end of the depreciation (sometimes called the salvage value of the asset).
+ * @param {number} uselife The number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
+ * @returns {number} returns the straightline depreciation of an asset for 1 period or error if arguments are not formatted properly.
+ */
+function sln(initcost, salvageval, uselife) {
+ return openf.SLN(initcost, salvageval, uselife);
+}
+exports.sln = sln;
+/**
+ * Returns the sum-of-years' digits depreciation of an asset for a specified period.
+ *
+ * Category: Financial
+ *
+ * @param {number} initcost The initial cost of the asset.
+ * @param {number} salvageval The value at the end of the depreciation (sometimes called the salvage value of the asset).
+ * @param {number} uselife The number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
+ * @param {number} periods The period and must use the same units as life.
+ * @returns {number} the sum-of-years' digits depreciation of an asset for a specified period or an error if arguments are not formatted properly.
+ */
+function syd(initcost, salvageval, uselife, periods) {
+ return openf.SYD(initcost, salvageval, uselife, periods);
+}
+exports.syd = syd;
+/**
+ * Returns the bond-equivalent yield for a Treasury bill.
+ *
+ * Category: Financial
+ *
+ * @param {Date|number|string} settlement_date The Treasury bill's settlement date. The security settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
+ * @param {Date|number|string} maturity_date The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
+ * @param {number} discount_rate The Treasury bill's discount rate.
+ * @returns {number} Returns the bond-equivalent yield for a Treasury bill or an error if the arguments are not formatted properly.
+ */
+function tbillEq(settlement_date, maturity_date, discount_rate) {
+ return openf.TBILLEQ(settlement_date, maturity_date, discount_rate);
+}
+exports.tbillEq = tbillEq;
+/**
+ * Returns the price per $100 face value for a Treasury bill.
+ *
+ * Category: Financial
+ *
+ * @param {Date|number|string} settlement_date The Treasury bill's settlement date. The security settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
+ * @param {Date|number|string} maturity_date The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
+ * @param {number} discount_rate The Treasury bill's discount rate.
+ * @returns {number} returns the price per $100 facec value for a treasury bill or an error if the arguments arent formatted properly.
+ */
+function tbillPrice(settlement_date, maturity_date, discount_rate) {
+ return openf.TBILLPRICE(settlement_date, maturity_date, discount_rate);
+}
+exports.tbillPrice = tbillPrice;
+/**
+ * Returns the yield for a Treasury bill.
+ *
+ * Category: Financial
+ *
+ * @param {Date|number|string} settlement_date The Treasury bill's settlement date. The security settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
+ * @param {Date|number|string} maturity_date The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
+ * @param {number} price The Treasury bill's price per $100 face value.
+ * @returns {number} the yield for a treasury bill or an error if the arguments are not formated properly
+ */
+function tbillYield(settlement_date, maturity_date, price) {
+ return openf.TBILLYIELD(settlement_date, maturity_date, price);
+}
+exports.tbillYield = tbillYield;
+/**
+ * Returns the depreciation of an asset for a specified or partial period by using a declining balance method.
+ *
+ * Category: Financial
+ *
+ * @param {*} cost The initial cost of the asset.
+ * @param {*} salvage The value at the end of the depreciation (sometimes called the salvage value of the asset). This value can be 0.
+ * @param {*} life The number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
+ * @param {*} start_period The starting period for which you want to calculate the depreciation. Start_period must use the same units as life.
+ * @param {*} end_period The ending period for which you want to calculate the depreciation. End_period must use the same units as life.
+ * @param {*} factor Optional. The rate at which the balance declines. If factor is omitted, it is assumed to be 2 (the double-declining balance method). Change factor if you do not want to use the double-declining balance method. For a description of the double-declining balance method, see DDB.
+ * @param {*} no_switch Optional. A logical value specifying whether to switch to straight-line depreciation when depreciation is greater than the declining balance calculation.
+ - If no_switch is TRUE, Microsoft Excel does not switch to straight-line depreciation even when the depreciation is greater than the declining balance calculation.
+ - If no_switch is FALSE or omitted, Excel switches to straight-line depreciation when depreciation is greater than the declining balance calculation.
+ * @returns (TBD)
+ */
+function vdb() {
+ return openf.VDB();
+}
+exports.vdb = vdb;
+/**
+ * Returns the internal rate of return for a schedule of cash flows that is not necessarily periodic.
+ *
+ * Category: Financial
+ *
+ * @param {number[]} cash_flows A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive and one negative value.
+ * @param {Date[]|number[]|string[]} paydates A schedule of payment dates that corresponds to the cash flow payments. Dates may occur in any order. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. .
+ * @param {number} [guess] Optional. A number that you guess is close to the result of XIRR.
+ * @returns {number} internal rate of return as a number or an error if the arguments are not formatted properly.
+ */
+function xirr(cash_flows, paydates, guess = 0.1) {
+ return openf.XIRR(cash_flows, paydates, guess);
+}
+exports.xirr = xirr;
+/**
+ * Returns the net present value for a schedule of cash flows that is not necessarily periodic.
+ *
+ * Category: Financial
+ *
+ * @param {number} disrate The discount rate to apply to the cash flows.
+ * @param {number[]} cash_flows A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive value and one negative value.
+ * @param {Date[]|number[]|string[]} paydates A schedule of payment dates that corresponds to the cash flow payments. The first payment date indicates the beginning of the schedule of payments. All other dates must be later than this date, but they may occur in any order.
+ * @returns {number} net present value for a schedule of cash flows or an error if the arguments are not formated properly.
+ */
+function xnpv(disrate, cash_flows, paydates) {
+ return openf.XNPV(disrate, cash_flows, paydates);
+}
+exports.xnpv = xnpv;
+/**
+ * Returns the yield on a security that pays periodic interest.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} rate The security's annual coupon rate.
+ * @param {*} pr The security's price per $100 face value.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function Yield() {
+ return openf.YIELD();
+}
+exports.Yield = Yield;
+/**
+ * Returns the annual yield for a discounted security; for example, a Treasury bill.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} pr The security's price per $100 face value.
+ * @param {*} redemption The security's redemption value per $100 face value.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function yieldDisc() {
+ return openf.YIELDDISC();
+}
+exports.yieldDisc = yieldDisc;
+/**
+ * Returns the annual yield of a security that pays interest at maturity.
+ *
+ * Category: Financial
+ *
+ * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
+ * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
+ * @param {*} issue The security's issue date, expressed as a serial date number.
+ * @param {*} rate The security's interest rate at date of issue.
+ * @param {*} pr The security's price per $100 face value.
+ * @param {*} basis Optional. The type of day count basis to use.
+ * @returns (TBD)
+ * @TODO this needs to be implemented.
+ */
+function yieldMat() {
+ return openf.YIELDMAT();
+}
+exports.yieldMat = yieldMat;
+//-----------------------------
+// Notes @functions financial
+//-----------------------------
+// Notes @Commands financial
+//# sourceMappingURL=financial.js.map
\ No newline at end of file
diff --git a/javadoc/folder.js.html b/javadoc/folder.js.html
new file mode 100644
index 00000000..fb150340
--- /dev/null
+++ b/javadoc/folder.js.html
@@ -0,0 +1,107 @@
+Source: folder.js
\ No newline at end of file
diff --git a/javadoc/fonts/Inconsolata-Regular.ttf b/javadoc/fonts/Inconsolata-Regular.ttf
new file mode 100644
index 00000000..457d262c
Binary files /dev/null and b/javadoc/fonts/Inconsolata-Regular.ttf differ
diff --git a/javadoc/fonts/OpenSans-Regular.ttf b/javadoc/fonts/OpenSans-Regular.ttf
new file mode 100644
index 00000000..e21ff5f1
Binary files /dev/null and b/javadoc/fonts/OpenSans-Regular.ttf differ
diff --git a/javadoc/fonts/WorkSans-Bold.ttf b/javadoc/fonts/WorkSans-Bold.ttf
new file mode 100644
index 00000000..0caaf4d4
Binary files /dev/null and b/javadoc/fonts/WorkSans-Bold.ttf differ
diff --git a/javadoc/formula.js.html b/javadoc/formula.js.html
new file mode 100644
index 00000000..48e73d8b
--- /dev/null
+++ b/javadoc/formula.js.html
@@ -0,0 +1,96 @@
+Source: formula.js
"use strict";
+/**
+ * @file formula
+ * @module formula
+ * @category Formula
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateFormulaContext = exports.set = exports.isValid = exports.Eval = exports.checkFormulaSyntax = exports.command = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesf_base = tslib_1.__importStar(require("../notes/formula"));
+const notesf = () => notesf_base;
+exports._notes = notesf_base;
+//-----------------------------
+// Notes @functions Formula
+/**
+ * Executes a Notes/Domino command. Most of the standard menu commands can be
+ * executed using @Command. In addition, a number of specialized commands are
+ * available. In a formula, any command invoked using @Command runs in the
+ * order you specify in the formula. This means that any changes made by the
+ * command, such as inserting text into a field, affect the rest of the formula
+ * (see exceptions).
+ *
+ * In the context of RosettaJS, the @Command is a Notes @Formula function that
+ * does not exist in the functions of the Notes @Formula language but rather an
+ * @Command command itself that accepts the command name to execute as its first
+ * argument and the accompanying command parameters as arguments 2 through n.
+ * Commands in the Notes Formula for the most part interact with specific items on the page,
+ * and thus expect these to exist in the context when the command is executed.
+ *
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_COMMAND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function command() {
+ return notesf().Command();
+}
+exports.command = command;
+/**
+ * Checks a block of commented out formula language code for errors.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CHECKFORMULASYNTAX.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function checkFormulaSyntax() {
+ return notesf().CheckFormulaSyntax();
+}
+exports.checkFormulaSyntax = checkFormulaSyntax;
+/**
+ * At run-time, compiles and runs each element in a text expression as a formula.
+ * Returns the result of the last formula expression in the list or an error if an
+ * error is generated by any of the formula expressions in the list.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EVAL.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function Eval() {
+ return notesf().Eval();
+}
+exports.Eval = Eval;
+/**
+ * Executes all validation formulas within the current form.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISVALID.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isValid() {
+ return notesf().IsValid();
+}
+exports.isValid = isValid;
+/**
+ * Assigns a value to a temporary variable for use within a formula.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SET.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function set() {
+ return notesf().Set();
+}
+exports.set = set;
+/**
+ * Updates the context of a formula to the Notes® client window currently being
+ * accessed by the code. For example, if the code accesses a new form called
+ * "Response" by using @Command([Compose]:"Response", @UpdateFormulaContext
+ * switches the context of the formula to this new form. Any subsequent functions in
+ * the code execute in the context of the Response document, not the current document.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_UPDATEFORMULACONTEXT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function updateFormulaContext() {
+ return notesf().UpdateFormulaContext();
+}
+exports.updateFormulaContext = updateFormulaContext;
+//# sourceMappingURL=formula.js.map
\ No newline at end of file
diff --git a/javadoc/help.js.html b/javadoc/help.js.html
new file mode 100644
index 00000000..855bf6a4
--- /dev/null
+++ b/javadoc/help.js.html
@@ -0,0 +1,48 @@
+Source: help.js
"use strict";
+/**
+ * @file Help
+ * @module help
+ * @category Help
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.helpUsingDatabase = exports.helpAboutNotes = exports.helpAboutDatabase = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/help"));
+exports._notes = notesc;
+//-----------------------------
+// Notes @Commands help
+/**
+ * Displays the About This Database or database policy document for the current
+ * database (which typically explains the purpose of the application, as well as
+ * its intended audience).
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_HELPABOUTDATABASE.html|www.hcltechsw.com }
+ */
+function helpAboutDatabase() {
+ return notesc.HelpAboutDatabase();
+}
+exports.helpAboutDatabase = helpAboutDatabase;
+/**
+ * Displays the Notes® splash screen that appears when you launch Notes/Domino. The
+ * screen displays the current release number and date.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_HELPABOUTNOTES.html|www.hcltechsw.com }
+ */
+function helpAboutNotes() {
+ return notesc.HelpAboutNotes();
+}
+exports.helpAboutNotes = helpAboutNotes;
+/**
+ * Displays the Using This Database document for the current database. The Using
+ * This Database document typically provides pointers on how to use an
+ * application's forms and views.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_HELPUSINGDATABASE.html|www.hcltechsw.com }
+ */
+function helpUsingDatabase() {
+ return notesc.HelpUsingDatabase();
+}
+exports.helpUsingDatabase = helpUsingDatabase;
+//# sourceMappingURL=help.js.map
\ No newline at end of file
diff --git a/javadoc/index.html b/javadoc/index.html
new file mode 100644
index 00000000..39c3d6e9
--- /dev/null
+++ b/javadoc/index.html
@@ -0,0 +1,3 @@
+Home
\ No newline at end of file
diff --git a/javadoc/information.js.html b/javadoc/information.js.html
new file mode 100644
index 00000000..20ab4b47
--- /dev/null
+++ b/javadoc/information.js.html
@@ -0,0 +1,478 @@
+Source: information.js
"use strict";
+/**
+ * @file Information
+ * @module information
+ * @category Information
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notesError = exports.templateVersion = exports.serverAccess = exports.isVirtualizedDirectory = exports.isUsingJavaElement = exports.isModalHelp = exports.isInCompositeApp = exports.isEmbeddedInsideWCT = exports.isAppInstalled = exports.getAddressBooks = exports.fontList = exports.configFile = exports.thisValue = exports.thisName = exports.soundex = exports.regQueryValue = exports.ldapServer = exports.languagePreference = exports.clientType = exports.browserInfo = exports.sheets = exports.sheet = exports.isRef = exports.isFormula = exports.info = exports.cell = exports.type = exports.na = exports.n = exports.isText = exports.isOdd = exports.isNumber = exports.isNonText = exports.isNA = exports.isLogical = exports.isEven = exports.isError = exports.isErr = exports.isBinary = exports.isBlank = exports.errorType = exports.error = exports._notes = exports._openFormula = void 0;
+const tslib_1 = require("tslib");
+const openf = tslib_1.__importStar(require("../openformula/information"));
+exports._openFormula = openf;
+const notesf = tslib_1.__importStar(require("../notes/information"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+exports._notes = notesf;
+//-----------------------------
+// Open Formula information
+// TODO: This does not match openformula implementation
+function error() {
+ return openf.ERROR();
+}
+exports.error = error;
+error.type = (error_val) => {
+ return openf.ERROR.TYPE(error_val);
+};
+exports.errorType = error.type;
+/**
+ * Returns TRUE if the value is blank.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} if the value is null.
+ * @example ISBLANK(null) // returns true.
+ */
+function isBlank(value) {
+ return openf.ISBLANK(value);
+}
+exports.isBlank = isBlank;
+/**
+ * Formula.js only
+ *
+ * @param {string} number the expression to be evaluated.
+ * @returns {boolean} true if number is a binary string, false if not.
+ * @example ISBINARY('0101101') // returns true.
+ */
+function isBinary(number) {
+ return openf.ISBINARY(number);
+}
+exports.isBinary = isBinary;
+/**
+ * Returns TRUE if the value is any error value except #N/A.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns (TBD)
+ */
+function isErr(value) {
+ return openf.ISERR(value);
+}
+exports.isErr = isErr;
+/**
+ * Returns TRUE if the value is any error value.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean}
+ */
+function isError(value) {
+ return API.isDefaultOpenFormula() ? exports._openFormula.ISERROR(value) : exports._notes.IsError(value);
+}
+exports.isError = isError;
+/**
+ * Returns TRUE if the number is even.
+ *
+ * Category: Information
+ *
+ * @param {number} number The value to test. If number is not an integer, it is truncated.
+ * @returns {number} true if a number is even and false if it is not
+ * @example ISEVEN(-3); // returns false.
+ * @example ISEVEN(2); // returns true.
+ */
+function isEven(number) {
+ return openf.ISEVEN(number);
+}
+exports.isEven = isEven;
+/**
+ * Returns TRUE if the value is a logical value.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} true if the value is true, and false if the value is false or 0.
+ * @example ISLOGICAL(true); // returns true.
+ * @example ISLOGICAL(0); // returns false.
+ */
+function isLogical(value) {
+ return openf.ISLOGICAL(value);
+}
+exports.isLogical = isLogical;
+/**
+ * Returns TRUE if the value is the #N/A error value.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} returns true if the value being evaluated is equal to error.na, false if not;
+ * @example ISNA(error.na); // returns true.
+ * @example ISNA(1); // returns false.
+ */
+function isNA(value) {
+ return openf.ISNA(value);
+}
+exports.isNA = isNA;
+/**
+ * Returns TRUE if the value is not text.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} true if value is not a string, false if it is.
+ * @example ISNONTEXT(1); // returns true.
+ * @example ISNONTEXT('string'); // returns false.
+ */
+function isNonText(value) {
+ return openf.ISNONTEXT(value);
+}
+exports.isNonText = isNonText;
+/**
+ * Returns TRUE if the value is a number.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} true if value is a number, false if not
+ */
+function isNumber(value) {
+ return openf.ISNUMBER(value);
+}
+exports.isNumber = isNumber;
+/**
+ * Returns TRUE if the number is odd.
+ *
+ * Category: Information
+ *
+ * @param {number} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} true if the value is an odd number, false if not.
+ * @example ISODD(1); // returns true.
+ * @example ISODD('string'); // returns false.
+ * @example ISODD(2.5); // returns false.
+ */
+function isOdd(value) {
+ return openf.ISODD(value);
+}
+exports.isOdd = isOdd;
+/**
+ * Returns TRUE if the value is text.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns {boolean} returns true if value has type string, false if not.
+ */
+function isText(value) {
+ return openf.ISTEXT(value);
+}
+exports.isText = isText;
+/**
+ * Returns a value converted to a number.
+ *
+ * Category: Information
+ *
+ * @param {*} value The value you want converted. N converts values listed in the following table.
+ * @returns {number | Error} value if it is a number, value.getTime if it is an instance of Date, 1 if true, 0 if false, otherwise it returns an error.
+ */
+function n(value) {
+ return openf.N(value);
+}
+exports.n = n;
+/**
+ * Returns the error value #N/A.
+ *
+ * Category: Information
+ *
+ * @returns {error} error.na
+ */
+function na() {
+ return openf.NA();
+}
+exports.na = na;
+/**
+ * Returns a number indicating the data type of a value.
+ *
+ * Category: Information
+ *
+ * @param {*} value Can be any Microsoft Excel value, such as a number, text, logical value, and so on.
+ * @returns {number | undefined} 1 if value is a number, 2 if value is text, 4 if value isLogical, 16 if value is an array, 64 if value is an error/
+ */
+function type(value) {
+ return openf.TYPE(value);
+}
+exports.type = type;
+/**
+ * Returns information about the formatting, location, or contents of a value.
+ * Category: Information
+ * @returns (TBD)
+ */
+function cell() {
+ return openf.CELL();
+}
+exports.cell = cell;
+/**
+ * Returns information about the current operating environment.
+ * Category: Information
+ * @returns (TBD)
+ */
+function info() {
+ return openf.INFO();
+}
+exports.info = info;
+/**
+ * Returns TRUE if there is a reference to a value that contains a formula.
+ * Category: Information
+ * @param {*} reference Reference is a reference to the value you want to test. Reference can be a value reference, a formula, or a name that refers to a value.
+ * @returns (TBD)
+ */
+function isFormula() {
+ return openf.ISFORMULA();
+}
+exports.isFormula = isFormula;
+/**
+ * Returns TRUE if the value is a reference.
+ * Category: Information
+ * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
+ * @returns (TBD)
+ */
+function isRef() {
+ return openf.ISREF();
+}
+exports.isRef = isRef;
+/**
+ * Returns the sheet number of the referenced sheet.
+ * Category: Information
+ * @param {*} value Optional. Value is the name of a sheet or a reference for which you want the sheet number. If value is omitted, SHEET returns the number of the sheet that contains the function.
+ * @returns (TBD)
+ */
+function sheet() {
+ return openf.SHEET();
+}
+exports.sheet = sheet;
+/**
+ * Returns the number of sheets in a reference.
+ * Category: Information
+ * @param {*} reference Optional. Reference is a reference for which you want to know the number of sheets it contains. If Reference is omitted, SHEETS returns the number of sheets in the workbook that contains the function.
+ * @returns (TBD)
+ */
+function sheets() {
+ return openf.SHEETS();
+}
+exports.sheets = sheets;
+//-----------------------------
+// Notes @functions information
+/**
+ * Determines the capabilities of a Web client, that is you can determine the
+ * properties of the browser for the current request.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_BROWSERINFO_8997.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function browserInfo() {
+ return notesf.BrowserInfo();
+}
+exports.browserInfo = browserInfo;
+/**
+ * Returns a text string to differentiate Notes® clients and World Wide Web browsers.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_CLIENTTYPE_FUNCTION.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function clientType() {
+ return notesf.ClientType();
+}
+exports.clientType = clientType;
+/**
+ * Returns 1 (True) if the value is an @ERROR value, returns 0 (False) if not
+ * an error.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISERROR.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+//export function isError ():boolean { //dup
+// return notesf.IsError();
+//};
+/**
+ * Returns user's specified preferred language setting.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_LANGUAGEPREFERENCE_FORMULA.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function languagePreference() {
+ return notesf.LanguagePreference();
+}
+exports.languagePreference = languagePreference;
+/**
+ * Returns the URL and port number of the LDAP listener in the current domain.
+ * Notes® looks for this information in several places, following this search
+ * sequence:
+ * 1. Searches on the current server.
+ * 2. Searches for the notes.ini variable labeled LDAPSERVER=.
+ * 3. Queries the administration server, which runs the LDAP service automatically, by default.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_LDAPSERVER_FUNCTION.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function ldapServer() {
+ return notesf.LDAPServer();
+}
+exports.ldapServer = ldapServer;
+/**
+ * Copies the administration execution control list from a specified Address Book
+ * and name to your personal workstation ECL.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_REGQUERYVALUE_FUNCTION.html|www.hcltechsw.com }
+ */
+function regQueryValue() {
+ return notesf.RegQueryValue();
+}
+exports.regQueryValue = regQueryValue;
+/**
+ * Returns the Soundex (the Notes® phonetic speller) code for the specified string.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_SOUNDEX.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function soundex() {
+ return notesf.Soundex();
+}
+exports.soundex = soundex;
+/**
+ * Returns the name of the current field.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_THISNAME.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function thisName() {
+ return notesf.ThisName();
+}
+exports.thisName = thisName;
+/**
+ * Returns the value of the current field.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_THISVALUE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function thisValue() {
+ return notesf.ThisValue();
+}
+exports.thisValue = thisValue;
+/**
+ * Returns the file path for the initialization file for Notes® (notes.ini).
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_CONFIGFILE_FUNCTION.html|www.hcltechsw.com }
+ */
+function configFile() {
+ return notesf.ConfigFile();
+}
+exports.configFile = configFile;
+/**
+ * Provides a list of available fonts on the Notes® client where this @function
+ * is executed.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_FONTLIST_1948.html|www.hcltechsw.com }
+ */
+function fontList() {
+ return notesf.FontList();
+}
+exports.fontList = fontList;
+/**
+ * Returns a list of the address books associated with a client (if the current
+ * database is local) or server.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_GETADDRESSBOOKS.html|www.hcltechsw.com }
+ */
+function getAddressBooks() {
+ return notesf.GetAddressBooks();
+}
+exports.getAddressBooks = getAddressBooks;
+/**
+ * Indicates whether the specified type of application is installed.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISAPPINSTALLED_FUNCTION.html|www.hcltechsw.com }
+ */
+function isAppInstalled() {
+ return notesf.IsAppInstalled();
+}
+exports.isAppInstalled = isAppInstalled;
+/**
+ * Indicates whether any part of the current Notes® session is embedded inside of
+ * Workplace client.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISEMBEDDEDINSIDEWCT.html|www.hcltechsw.com }
+ */
+function isEmbeddedInsideWCT() {
+ return notesf.IsEmbeddedInsideWCT();
+}
+exports.isEmbeddedInsideWCT = isEmbeddedInsideWCT;
+/**
+ * Indicates whether the component is running within a composite application.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISINCOMPOSITEAPP.html|www.hcltechsw.com }
+ */
+function isInCompositeApp() {
+ return notesf.IsInCompositeApp();
+}
+exports.isInCompositeApp = isInCompositeApp;
+/**
+ * Indicates whether the current document is a modal Help document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISMODALHELP.html|www.hcltechsw.com }
+ */
+function isModalHelp() {
+ return notesf.IsModalHelp();
+}
+exports.isModalHelp = isModalHelp;
+/**
+ * Indicates whether a view or outline uses the Java™ user interface.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISUSINGJAVAELEMENT.html|www.hcltechsw.com }
+ */
+function isUsingJavaElement() {
+ return notesf.IsUsingJavaElement();
+}
+exports.isUsingJavaElement = isUsingJavaElement;
+/**
+ * Indicates whether virtualized directories are enabled for the current server.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISVIRTUALIZEDDIRECTORY.html|www.hcltechsw.com }
+ */
+function isVirtualizedDirectory() {
+ return notesf.IsVirtualizedDirectory();
+}
+exports.isVirtualizedDirectory = isVirtualizedDirectory;
+/**
+ * Checks if a specified user has a specified administrative access level to a
+ * server.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_SERVERACCESS.html|www.hcltechsw.com }
+ */
+function serverAccess() {
+ return notesf.ServerAccess();
+}
+exports.serverAccess = serverAccess;
+/**
+ * Returns the version number of the master template upon which the
+ * database design is based.
+
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_TEMPLATEVERSION.html|www.hcltechsw.com }
+ */
+function templateVersion() {
+ return notesf.TemplateVersion();
+}
+exports.templateVersion = templateVersion;
+/**
+ * Allows you to generate an error condition within an expression. This is useful
+ * if you want to evaluate the current values in several fields and need to know if
+ * an error has occurred in the entry of any of them.
+ * @throws {Error} Notes Error
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ERROR.html|www.hcltechsw.com }
+ */
+function notesError() {
+ return notesf.NotesError();
+}
+exports.notesError = notesError;
+//# sourceMappingURL=information.js.map
\ No newline at end of file
diff --git a/javadoc/layout.js.html b/javadoc/layout.js.html
new file mode 100644
index 00000000..fee2803d
--- /dev/null
+++ b/javadoc/layout.js.html
@@ -0,0 +1,70 @@
+Source: layout.js
"use strict";
+/**
+ * @file Layout
+ * @module layout
+ * @category Layout
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.layoutProperties = exports.layoutElementSendToBack = exports.layoutElementProperties = exports.layoutElementBringToFront = exports.layoutAddText = exports.layoutAddGraphic = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/layout"));
+exports._notes = notesc;
+/**
+ * Adds a graphic from the Clipboard to a layout region.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAYOUTADDGRAPHIC.html|www.hcltechsw.com }
+ */
+function layoutAddGraphic() {
+ return notesc.LayoutAddGraphic();
+}
+exports.layoutAddGraphic = layoutAddGraphic;
+/**
+ * Creates a static text box in a layout region.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAYOUTADDTEXT.html|www.hcltechsw.com }
+ */
+function layoutAddText() {
+ return notesc.LayoutAddText();
+}
+exports.layoutAddText = layoutAddText;
+/**
+ * Brings the selected layout element to the front, which means it overlays any
+ * other layout elements that overlap it.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAYOUTELEMENTBRINGTOFRONT.html|www.hcltechsw.com }
+ */
+function layoutElementBringToFront() {
+ return notesc.LayoutElementBringToFront();
+}
+exports.layoutElementBringToFront = layoutElementBringToFront;
+/**
+ * Displays the Properties box for the currently selected layout element.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAYOUTELEMENTPROPERTIES.html|www.hcltechsw.com }
+ */
+function layoutElementProperties() {
+ return notesc.LayoutElementProperties();
+}
+exports.layoutElementProperties = layoutElementProperties;
+/**
+ * Sends the selected layout element to the back, which means it displays
+ * underneath any other layout elements that overlap it.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAYOUTELEMENTSENDTOBACK.html|www.hcltechsw.com }
+ */
+function layoutElementSendToBack() {
+ return notesc.LayoutElementSendToBack();
+}
+exports.layoutElementSendToBack = layoutElementSendToBack;
+/**
+ * Displays the Properties box for the currently selected layout region.
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAYOUTPROPERTIES.html|www.hcltechsw.com }
+ */
+function layoutProperties() {
+ return notesc.LayoutProperties();
+}
+exports.layoutProperties = layoutProperties;
+//# sourceMappingURL=layout.js.map
\ No newline at end of file
diff --git a/javadoc/lists.js.html b/javadoc/lists.js.html
new file mode 100644
index 00000000..565b79f6
--- /dev/null
+++ b/javadoc/lists.js.html
@@ -0,0 +1,193 @@
+Source: lists.js
"use strict";
+/**
+ * @file Lists
+ * @module lists
+ * @category Lists
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unique = exports.transform = exports.subset = exports.sort = exports.select = exports.replace = exports.nothing = exports.member = exports.keywords = exports.isNotMember = exports.isMember = exports.implode = exports.explode = exports.elements = exports.count = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesf = tslib_1.__importStar(require("../notes/lists"));
+exports._notes = notesf;
+//-----------------------------
+// Open Formula lists
+//-----------------------------
+// Notes @functions lists
+/**
+ * Calculates the number of text, number, or time-date values in a list. This
+ * function always returns a number to indicate the number of entries in the list.
+ *
+ * This function is similar to @Elements, except that it returns the number 1
+ * instead of 0, when the value it is evaluating is not a list or is a null string.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_COUNT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function count() {
+ return notesf.Count();
+}
+exports.count = count;
+/**
+ * Calculates the number of text, number, or time-date values in a list. This
+ * function always returns a number to indicate the number of entries in the list.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ELEMENTS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function elements() {
+ return notesf.Elements();
+}
+exports.elements = elements;
+/**
+ * Returns a text list composed of the elements of a text string or date range.
+ *
+ * - If you specify a text string, elements are defined as sequences of characters
+ * separated by separator characters and newlines.
+ * - If you specify a time-date range, elements are defined as individual days within
+ * the range.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EXPLODE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function explode() {
+ return notesf.Explode();
+}
+exports.explode = explode;
+/**
+ * Concatenates all members of a text list and returns a text string.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_IMPLODE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function implode() {
+ return notesf.Implode();
+}
+exports.implode = implode;
+/**
+ * Indicates if a piece of text (or a text list) is contained within another text
+ * list. The function is case-sensitive.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISMEMBER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isMember() {
+ return notesf.IsMember();
+}
+exports.isMember = isMember;
+/**
+ * Indicates if a text string (or a text list) is not contained within another text
+ * list. The function is case-sensitive.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ISNOTMEMBER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function isNotMember() {
+ return notesf.IsNotMember();
+}
+exports.isNotMember = isNotMember;
+/**
+ * Given two text lists, returns only those items from the second list that are
+ * found in the first list.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_KEYWORDS.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function keywords() {
+ return notesf.Keywords();
+}
+exports.keywords = keywords;
+/**
+ * Given a value, finds its position in a text list.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MEMBER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function member() {
+ return notesf.Member();
+}
+exports.member = member;
+/**
+ * Use with an @Transform formula. Returns no list element (reducing the return
+ * list by one element). Not valid in any other context.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NOTHING.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function nothing() {
+ return notesf.Nothing();
+}
+exports.nothing = nothing;
+/**
+ * Repeats a string a specified number of times.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REPLACE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function replace() {
+ return notesf.Replace();
+}
+exports.replace = replace;
+/**
+ * Returns the value that appears in the number position. If the number is greater
+ * than the number of values, @Select returns the last value in the list. If
+ * the value in the number position is a list, returns the entire list contained
+ * within the value.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_SELECT_AT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function select() {
+ return notesf.Select();
+}
+exports.select = select;
+/**
+ * Sorts a list.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SORT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function sort() {
+ return notesf.Sort();
+}
+exports.sort = sort;
+/**
+ * Searches a list from beginning to end and returns the number values you specify.
+ * If you specify a negative number, @Subset searches the list from end to
+ * beginning, but the result is ordered as from the beginning of the list.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SUBSET.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function subset() {
+ return notesf.Subset();
+}
+exports.subset = subset;
+/**
+ * Applies a formula to each element of a list and returns the results in a list.
+ * @returns {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_TRANSFORM.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function transform() {
+ return notesf.Transform();
+}
+exports.transform = transform;
+/**
+ * Without a parameter, returns a random, unique text value. With a parameter,
+ * removes duplicate values from a text list by returning only the first occurrence
+ * of each member of the list.
+ * @param text - list of values
+ * @returns If no parameter is specified, returns a random, unique text value. Otherwise, the _text_ list, with
+ * duplicate values removed.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_UNIQUE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function unique(...text) {
+ return notesf.Unique(...text);
+}
+exports.unique = unique;
+//-----------------------------
+// Notes @Commands lists
+//# sourceMappingURL=lists.js.map
\ No newline at end of file
diff --git a/javadoc/logical.js.html b/javadoc/logical.js.html
new file mode 100644
index 00000000..60339d0d
--- /dev/null
+++ b/javadoc/logical.js.html
@@ -0,0 +1,269 @@
+Source: logical.js
"use strict";
+/**
+ * @file Logical
+ * @module logical
+ * @category Logical
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const openf_logic = require('../openformula/logical');
+exports._openFormula = openf_logic;
+const notesf_logic = require('../notes/logical');
+exports._notes = notesf_logic;
+const API = tslib_1.__importStar(require("../rosetta/API"));
+//-----------------------------
+// Rosetta logical - common functions (exist in both OpenFormula and Notes Formula)
+/**
+ * Returns the logical value false (or the number 0).
+ *
+ * @returns {boolean | number} False (or 0).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_FALSE.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#FALSE | www.oasis-open.org}
+ * @example rosettajs.false(); // returns false (openf) or 0 (notesf)
+ */
+exports.false = () => {
+ return API.isDefaultOpenFormula() ? openf_logic.FALSE() : notesf_logic.False();
+};
+/**
+ * Specifies a logical test to perform and returns the specified value determined by the test.
+ *
+ * @param {any} args The parameters that include the condition/action pair(s), and else action.
+ * @returns {any} The resulting value if true or false.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_IF.html | www.hcltechsw.com}
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#IF | www.oasis-open.org}
+ * @example rosettajs.if(55 >= 12.45, "Over Budget", "OK") // returns "Over Budget"
+ */
+exports.if = function (...args) {
+ let value_if_true = arguments.length >= 2 ? args[1] : true;
+ let value_if_false = arguments.length === 3 ? args[2] : false;
+ return API.isDefaultOpenFormula() ? openf_logic.IF(args[0], value_if_true, value_if_false) : notesf_logic.If(...args);
+};
+/**
+ * Returns a value you specify if a formula evaluates to an error; otherwise, returns the result of the formula.
+ *
+ * @param {any} value The argument that is checked for an error.
+ * @param {any} value_if_error The value to return if the formula evaluates to an error. The following error types are evaluated: #N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!.
+ * @returns {any} The value you specify if a formula evaluates to an error; otherwise, returns the result of the formula.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_IFERROR_FUNCTION.html | www.hcltechsw.com}
+ * @example rosettajs.ifError(error.value, 2) // returns 2
+ */
+exports.ifError = (value, value_if_error) => {
+ return API.isDefaultOpenFormula() ? openf_logic.IFERROR(value, value_if_error) : notesf_logic.IfError(value, value_if_error);
+};
+/**
+ * Returns the logical value true (or the number 1).
+ *
+ * @returns {boolean | number} True (or 1)
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_TRUE.html | www.hcltechsw.com}
+ * @example rosettajs.true(); // returns true (openf) or 1 (notesf)
+ */
+exports.true = () => {
+ return API.isDefaultOpenFormula() ? openf_logic.TRUE() : notesf_logic.True();
+};
+//-----------------------------
+// Open Formula logical
+/**
+ * Returns TRUE if all of its arguments are TRUE.
+ *
+ * @param {any[]} values The values to determine whether they are true or not.
+ * @returns {boolean} True if all of the arguments are true. False if any value is not true.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#AND | www.oasis-open.org}
+ * @example rosettajs.and(true, false) // returns false
+ */
+exports.and = (...values) => {
+ return openf_logic.AND(...values);
+};
+/**
+ * Checks whether one or more conditions are met and returns a value that corresponds to the first TRUE condition.
+ *
+ * @param {any[]} args One or more conditions.
+ * @returns {any} The value that corresponds to the first TRUE condition.
+ * @example rosettajs.ifs(false, 1, true, 2) // returns 2
+ */
+exports.ifs = (...args) => {
+ return openf_logic.IFS(...args);
+};
+/**
+ * Returns the value you specify if the expression resolves to #N/A, otherwise returns the result of the expression.
+ *
+ * @param {any} value The expression to compute.
+ * @param {any} value_if_na The result of the expression to return if the value is not #N/A.
+ * @returns {any} The value you specify if the expression resolves to #N/A, otherwise returns the result of the expression.
+ * @example rosettajs.ifNA(error.na, 2) // returns 2
+ */
+exports.ifNA = (value, value_if_na) => {
+ return openf_logic.IFNA(value, value_if_na);
+};
+/**
+ * Reverses the logic of its argument.
+ *
+ * @param {boolean} logical The expression to reverse.
+ * @returns {boolean} The reversed logic of the logical expression.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#NOT | www.oasis-open.org}
+ * @example rosettajs.not(false) // returns true
+ */
+exports.not = (logical) => {
+ return openf_logic.NOT(logical);
+};
+/**
+ * Returns TRUE if any argument is TRUE.
+ *
+ * @param {any[]} values The values to determine whether they are true or not.
+ * @returns {boolean} True if any one of the arguments are true. False if all values are false.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#OR | www.oasis-open.org}
+ * @example rosettajs.or(true, false) // returns true
+ */
+exports.or = (...values) => {
+ return openf_logic.OR(...values);
+};
+/**
+ * Evaluates an expression against a list of values and returns the result corresponding to the first matching value.
+ * If there is no match, an optional default value may be returned.
+ *
+ * @param {any[]} args The expression and values to compare.
+ * @returns {any} The result corresponding to the first matching value.
+ * @example rosettajs.switch() // returns
+ */
+exports.switch = (...args) => {
+ return openf_logic.SWITCH(...args);
+};
+/**
+ * Returns a logical exclusive OR of all arguments.
+ *
+ * @param {any[]} values logical1, logical2,… Logical 1 is required, subsequent logical values are optional.
+ * 1 to 254 conditions you want to test that can be either TRUE or FALSE, and can be logical values, arrays, or references.
+ * @returns {boolean} The logical exclusive OR of all arguments.
+ * @example rosettajs.xor()
+ */
+exports.xor = (...values) => {
+ return openf_logic.XOR(...values);
+};
+//-----------------------------
+// Notes @functions logical
+/**
+ * Evaluates expressions from left to right, and returns the value of the last
+ * expression in the list.
+ *
+ * @param {any} expressions One or more expressions to evaluate.
+ * @returns {any} The resulting value of the last expression in the list.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_DO.html | www.hcltechsw.com}
+ * @example rosettajs.do(rosettajs.success(), true, false, "message") // returns "message"
+ */
+exports.do = (...expressions) => {
+ return notesf_logic.Do(...expressions);
+};
+/**
+ * Executes one or more statements iteratively while a condition is true. Checks
+ * the condition after executing the statements.
+ *
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_DOWHILE_FUNCTION.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+exports.doWhile = () => {
+ return notesf_logic.DoWhile();
+};
+/**
+ * Returns text that indicates that input to a field does not meet validation.
+ *
+ * @param {string} message The error message to be displayed to the user.
+ * @returns {string} The message indicating the failure.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_FAILURE.html | www.hcltechsw.com}
+ * @example rosettajs.failure("Failure message test") // returns "Failure message test"
+ */
+exports.failure = (message) => {
+ return notesf_logic.Failure(message);
+};
+/**
+ * Executes one or more statements iteratively while a condition remains true.
+ * Executes an initialization statement. Checks the condition before executing the
+ * statements and executes an increment statement after executing the statements.
+ *
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_FOR_FUNCTION.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+exports.for = () => {
+ return notesf_logic.For();
+};
+/**
+ * Tests for a null value. Returns true only if a value is a single text value that
+ * is null, otherwise it returns false. This function also returns false if the
+ * value is an error.
+ *
+ * @param {any} value The value to test for null.
+ * @returns {boolean} True if value is null, otherwise false.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_ISNULL.html | www.hcltechsw.com}
+ * @example rosettajs.isNull(null) // true
+ * @example rosettajs.isNull(4) // false
+
+ */
+exports.isNull = (value) => {
+ return notesf_logic.IsNull(value);
+};
+/**
+ * Returns the number 0 (false).
+ *
+ * @returns {number} The number 0 (false).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_NO.html | www.hcltechsw.com}
+ * @example rosettajs.no() // returns 0
+ */
+exports.no = () => {
+ return notesf_logic.No();
+};
+/**
+ * Immediately stops the execution of a formula and returns the specified value.
+ * This is useful when you only want the remainder of the formula to be executed
+ * only if certain conditions are True.
+ *
+ * @param {any} value The value to return.
+ * @returns {any} The value.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_RETURN.html | www.hcltechsw.com}
+ * @example rosettajs.return('Message to return') // throws 'Message to return'
+ */
+exports.return = (value) => {
+ return notesf_logic.Return(value);
+};
+/**
+ * Returns 1 (True). Use this function with @If in field validation formulas to
+ * indicate that the value entered satisfies the validation criteria.
+ *
+ * @returns {number} The number 1 (true).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_SUCCESS.html | www.hcltechsw.com}
+ * @example rosettajs.success() // returns 1
+ */
+exports.success = () => {
+ return notesf_logic.Success();
+};
+/**
+ * Returns the names of the folders containing the current document.
+ *
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_WHILE_FUNCTION.html | www.hcltechsw.com}
+ * @TODO this needs to be implemented
+ */
+exports.while = () => {
+ return notesf_logic.While();
+};
+/**
+ * Returns the number 1 (true).
+ *
+ * @returns {number} The number 1 (true).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_YES.html | www.hcltechsw.com}
+ * @example rosettajs.yes() // returns 1
+ */
+exports.yes = () => {
+ return notesf_logic.Yes();
+};
+/**
+ * This function performs an @If operation; the syntax is the same as for @if.
+ *
+ * @throws {Error} No plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.2/basic/H_V2IF.html | www.hcltechsw.com}
+ */
+exports.v2If = () => {
+ return notesf_logic.V2If();
+};
+//# sourceMappingURL=logical.js.map
\ No newline at end of file
diff --git a/javadoc/lookup-reference.js.html b/javadoc/lookup-reference.js.html
new file mode 100644
index 00000000..b7e80e39
--- /dev/null
+++ b/javadoc/lookup-reference.js.html
@@ -0,0 +1,216 @@
+Source: lookup-reference.js
"use strict";
+/**
+ * @file Lookup Reference
+ * @module lookup-reference
+ * @category Lookup Reference
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unique = exports.choose = exports.columns = exports.column = exports.row = exports.rows = exports.transpose = exports.index = exports.lookup = exports.hLookup = exports.vLookup = exports.match = exports._openFormula = void 0;
+const tslib_1 = require("tslib");
+const openf = tslib_1.__importStar(require("../openformula/lookup-reference"));
+exports._openFormula = openf;
+const error = tslib_1.__importStar(require("../utils/error"));
+//-----------------------------
+// Open Formula lookup-reference
+/**
+ * Looks up values in a reference or array.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {*} lookup_value The value that you want to match in lookup_array. For example, when you look up someone's number in a telephone book, you are using the person's name as the lookup value, but the telephone number is the value you want.The lookup_value argument can be a value (number, text, or logical value) or a value reference to a number, text, or logical value.
+ * @param {any[]} lookup_array The range of values being searched.
+ * @param {number} match_type Optional. The number -1, 0, or 1. The match_type argument specifies how Excel matches lookup_value with values in lookup_array. The default value for this argument is 1.
+ * @see For futher information, see ;nbsp {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#MATCH | www.oasis-open.org}
+ * @returns {number | Error} the index of the value you are attempting to lookup via match_type, or it returns an error.
+ * @example match(1, [[0], [1], [2], [3], [4]]) //returns 2
+ * @example match('*mc', ['jima', 'jimb', 'jimc', 'bernie'], 0) //returns 3
+ *
+ */
+function match(lookup_value, lookup_array, match_type = 1) {
+ return openf.MATCH(lookup_value, lookup_array, match_type);
+}
+exports.match = match;
+/**
+ * Looks in the first column of an array and moves across the row to return the value of a value.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {*} lookup_value The value to be found in the first row of the table. Lookup_value can be a value, a reference, or a text string.
+ * @param {any[][]} table_array A table of information in which data is looked up. Use a reference to a range or a range name.
+ * @param {number} col_index_num The row number in table_array from which the matching value will be returned. A row_index_num of 1 returns the first row value in table_array, a row_index_num of 2 returns the second row value in table_array, and so on. If row_index_num is less than 1, VLOOKUP returns the #VALUE! error value; if row_index_num is greater than the number of rows on table_array, VLOOKUP returns the #REF! error value.
+ * @param {boolean} [range_lookup] Optional. A logical value that specifies whether you want VLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, VLOOKUP will find an exact match. If one is not found, the error value #N/A is returned.
+ * @see For futher information, see ;nbsp {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#VLOOKUP | www.oasis-open.org}
+ * @returns {any | Error} the value in the table_array second column based on the index of the value looked up in the first column.
+ * @example rosetta.vLookup('jim', [['jam', 2], ['jim', 4]], 2, false) //returns 4
+ * @example rosetta.vLookup(1.1, [[0, 'A'], [1, 'B'], [2, 'C'], [1, 'D']], 2, true) //returns 'B'
+ */
+function vLookup(lookup_value, table_array, col_index_num, range_lookup) {
+ return openf.VLOOKUP(lookup_value, table_array, col_index_num, range_lookup);
+}
+exports.vLookup = vLookup;
+/**
+ * Looks in the top row of an array and returns the value of the indicated value.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {*} lookup_value The value to be found in the first row of the table. Lookup_value can be a value, a reference, or a text string.
+ * @param {any[][]} table_array A table of information in which data is looked up. Use a reference to a range or a range name.
+ * @param {number} row_index_num The row number in table_array from which the matching value will be returned. A row_index_num of 1 returns the first row value in table_array, a row_index_num of 2 returns the second row value in table_array, and so on. If row_index_num is less than 1, HLOOKUP returns the #VALUE! error value; if row_index_num is greater than the number of rows on table_array, HLOOKUP returns the #REF! error value.
+ * @param {boolean} [range_lookup] Optional. A logical value that specifies whether you want HLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, HLOOKUP will find an exact match. If one is not found, the error value #N/A is returned.
+ * @see For futher information, see ;nbsp {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#VLOOKUP | www.oasis-open.org}
+ * @returns {any | Error} the value in the table_array second column based on the index of the value looked up in the first column.
+ * @example rosetta.hLookup(0, [[1, 0], ['jim', 'jam']], 2, false) //returns'jam'
+ * @example rosetta.hLookup(1.4, [[0, 1, 2, 1], ['A', 'B', 'C', 'D']], 2) //returns 'B'
+ */
+function hLookup(lookup_value, table_array, row_index_num, range_lookup) {
+ return openf.HLOOKUP(lookup_value, table_array, row_index_num, range_lookup);
+}
+exports.hLookup = hLookup;
+/**
+ * Looks up values in a vector or array.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {*} lookup_value A value that LOOKUP searches for in an array. The lookup_value argument can be a number, text, a logical value, or a name or reference that refers to a value.
+ - If LOOKUP can't find the value of lookup_value, it uses the largest value in the array that is less than or equal to lookup_value.
+ - If the value of lookup_value is smaller than the smallest value in the first row or column (depending on the array dimensions), LOOKUP returns the #N/A error value.
+ * @param {any[]} array A range of values that contains text, numbers, or logical values that you want to compare with lookup_value. The array form of LOOKUP is very similar to the HLOOKUP and VLOOKUP functions. The difference is that HLOOKUP searches for the value of lookup_value in the first row, VLOOKUP searches in the first column, and LOOKUP searches according to the dimensions of array.
+ * @param {any[]} [result_array] Optional. A range that contains only one row or column. The result_array argument must be the same size as lookup_value. It has to be the same size.
+ * @see For futher information, see ;nbsp {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#LOOKUP | www.oasis-open.org}
+ * @returns {any | Error} the value in the result_array at the same index from the first array that is closest to the lookup_value
+ * @example lookup('Jack', ['Jim', 'Jack', 'Franck'], ['blue', 'yellow', 'red']) //returns 'yellow'
+ * @example lookup(0.21, [[0.1, 0.2, 0.3, 0.2]], [['A', 'B', 'C', 'D']]) //returns 'B'
+ */
+function lookup(lookup_value, array, result_array) {
+ return openf.LOOKUP(lookup_value, array, result_array);
+}
+exports.lookup = lookup;
+/**
+ * Uses an index to choose a value from a reference or array.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {any[]} array A range of values or an array constant.
+ - If array contains only one row or column, the corresponding row_num or column_num argument is optional.
+ - If array has more than one row and more than one column, and only row_num or column_num is used, INDEX returns an array of the entire row or column in array.
+ * @param {number} row_num Required, unless column_num is present. Selects the row in array from which to return a value. If row_num is omitted, column_num is required.
+ * @param {number} [column_num] Optional. Selects the column in array from which to return a value. If column_num is omitted, row_num is required.
+ * * @see For futher information, see ;nbsp {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#INDEX | www.oasis-open.org}
+ * @returns {any | Error } returns the value at a given index from a datasource.
+ * @example rosetta.index([['Banana', 'Apple'],['Strawberry', 'Pineapple']], 2, 1) //returns 'Strawberry'
+ * @example rosetta.index([['Banana', 'Apple'],['Strawberry', 'Pineapple']], 1, 2) //returns 'Apple'
+ */
+function index(array, row_num, column_num) {
+ return openf.INDEX(array, row_num, column_num);
+}
+exports.index = index;
+/**
+ * Returns the transpose of an array.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {number[][]} array An array or range of values on a worksheet that you want to transpose. The transpose of an array is created by using the first row of the array as the first column of the new array, the second row of the array as the second column of the new array, and so on. If you're not sure of how to enter an array formula, see Create an array formula.
+ * @returns {number[][]} the transpose of an array or an error if the arguments are incorrect.
+ */
+function transpose(array) {
+ return openf.TRANSPOSE(array);
+}
+exports.transpose = transpose;
+/**
+ * Returns the number of rows in a reference.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {number[][]} array An array, an array formula, or a reference to a range of values for which you want the number of rows.
+ * @returns the number of rows in a reference or an error if the arguments are incorect.
+ */
+function rows(array) {
+ if (arguments.length !== 1) {
+ return error.na;
+ }
+ return openf.ROWS(array);
+}
+exports.rows = rows;
+/**
+ * Returns the row number of a reference.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {number[][]} reference the value or range of values for which you want the row number.
+ * @param {number} index
+ * @returns {number} the row number of a reference or an error if the arguments are incorrect.
+ */
+function row(reference, index) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.ROW(reference, index);
+}
+exports.row = row;
+/**
+ * Returns the column number of a reference.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {any[][]} reference the value or range of values for which you want to return the column number.
+ * @param {number} index
+ * @returns {number} the column number of a reference or an error if the arguments are incorrect.
+ */
+function column(reference, index) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.COLUMN(reference, index);
+}
+exports.column = column;
+/**
+ * Returns the number of columns in a reference.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {any[][]} array An array or array formula, or a reference to a range of values for which you want the number of columns.
+ * @returns {number} the number of columns in a reference or an error if the arguments are incorrect.
+ */
+function columns(array) {
+ if (arguments.length !== 1) {
+ return error.na;
+ }
+ return openf.COLUMNS(array);
+}
+exports.columns = columns;
+/**
+ * Chooses a value from a list of values.
+ *
+ * Category: Lookup and reference
+ *
+ * @param {number} index_num Specifies which value argument is selected. Index_num must be a number between 1 and 254, or a formula or reference to a value containing a number between 1 and 254. If index_num is 1, CHOOSE returns value1; if it is 2, CHOOSE returns value2; and so on. If index_num is less than 1 or greater than the number of the last value in the list, CHOOSE returns the #VALUE! error value. If index_num is a fraction, it is truncated to the lowest integer before being used.
+ - If index_num is 1, CHOOSE returns value1; if it is 2, CHOOSE returns value2; and so on.
+ - If index_num is less than 1 or greater than the number of the last value in the list, CHOOSE returns the #VALUE! error value.
+ - If index_num is a fraction, it is truncated to the lowest integer before being used.
+ * @param {number} index_num the index of the value to return.
+ * @param {*} args value1, value2, ... Value 1 is required, subsequent values are optional. 1 to 254 value arguments from which CHOOSE selects a value or an action to perform based on index_num. The arguments can be numbers, value references, defined names, formulas, functions, or text.
+ * @see For futher information, see ;nbsp {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#CHOOSE | www.oasis-open.org}
+ * @returns {any} the value at a given index, or an error where it specifies an index that does not exist.
+ * @example lookup.CHOOSE(3, 'jima', 'jimb', 'jimc') //returns ('jimc')
+ * @example lookup.CHOOSE(2, 'jima') //returns (error.value)
+ */
+function choose(index_num, ...args) {
+ return openf.CHOOSE(index_num, ...args);
+}
+exports.choose = choose;
+/**
+ * Returns a list of unique values in a list or range.
+ * @param values The list of values
+ * @returns A list of unique values
+ */
+function unique(...values) {
+ return openf.UNIQUE(...values);
+}
+exports.unique = unique;
+//-----------------------------
+// Notes @functions lookup-reference
+//-----------------------------
+// Notes @Commands lookup-reference
+//# sourceMappingURL=lookup-reference.js.map
\ No newline at end of file
diff --git a/javadoc/mail.js.html b/javadoc/mail.js.html
new file mode 100644
index 00000000..758788d7
--- /dev/null
+++ b/javadoc/mail.js.html
@@ -0,0 +1,194 @@
+Source: mail.js
"use strict";
+/**
+ * @file Mail
+ * @module mail
+ * @category Mail
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mailSignPreference = exports.mailSendPublicKey = exports.mailSendEncryptionKey = exports.mailSendCertificateRequest = exports.mailSend = exports.mailScanUnread = exports.mailSavePreference = exports.mailRequestNewPublicKey = exports.mailRequestNewName = exports.mailRequestCrossCert = exports.mailOpen = exports.mailForwardAsAttachment = exports.mailForward = exports.mailEncryptSentPreference = exports.mailEncryptSavedPreference = exports.mailComposeMemo = exports.mailAddress = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/mail"));
+exports._notes = notesc;
+//-----------------------------
+// Notes @Commands mail
+/**
+ * Displays the Select Addresses dialog box, where the user can select people and
+ * groups to include in an address field of a mail document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILADDRESS.html|www.hcltechsw.com }
+ */
+function mailAddress() {
+ return notesc.MailAddress();
+}
+exports.mailAddress = mailAddress;
+/**
+ * Creates and displays a blank mail document. Notes/Domino uses the default form
+ * for the user's mail database. This is a Memo document unless the user has
+ * changed it.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILCOMPOSEMEMO.html|www.hcltechsw.com }
+ */
+function mailComposeMemo() {
+ return notesc.MailComposeMemo();
+}
+exports.mailComposeMemo = mailComposeMemo;
+/**
+ * Indicates whether the user has selected "Encrypt saved mail" in the User
+ * Preferences dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILENCRYPTSAVEDPREFERENCE.html|www.hcltechsw.com }
+ */
+function mailEncryptSavedPreference() {
+ return notesc.MailEncryptSavedPreference();
+}
+exports.mailEncryptSavedPreference = mailEncryptSavedPreference;
+/**
+ * Indicates whether the user has selected "Encrypt sent mail" in the User
+ * Preferences dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILENCRYPTSENTPREFERENCE.html|www.hcltechsw.com }
+ */
+function mailEncryptSentPreference() {
+ return notesc.MailEncryptSentPreference();
+}
+exports.mailEncryptSentPreference = mailEncryptSentPreference;
+/**
+ * Forwards the current document by placing its contents into a mail memo, which
+ * the user then addresses and sends like any other mail memo.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILFORWARD.html|www.hcltechsw.com }
+ */
+function mailForward() {
+ return notesc.MailForward();
+}
+exports.mailForward = mailForward;
+/**
+ * In cc:Mail, forwards a Notes/Domino document as a cc:Mail attachment.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILFORWARDASATTACHMENT.html|www.hcltechsw.com }
+ */
+function mailForwardAsAttachment() {
+ return notesc.MailForwardAsAttachment();
+}
+exports.mailForwardAsAttachment = mailForwardAsAttachment;
+/**
+ * Opens the user's mail database to the view or navigator to which it was most
+ * recently open.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILOPEN.html|www.hcltechsw.com }
+ */
+function mailOpen() {
+ return notesc.MailOpen();
+}
+exports.mailOpen = mailOpen;
+/**
+ * Displays the Choose ID to be Cross-Certified dialog box, which allows an
+ * administrator to send a safe copy of a Certifier ID to another administrator,
+ * who can certify it with a different Certifier ID to create a cross certificate.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILREQUESTCROSSCERT.html|www.hcltechsw.com }
+ */
+function mailRequestCrossCert() {
+ return notesc.MailRequestCrossCert();
+}
+exports.mailRequestCrossCert = mailRequestCrossCert;
+/**
+ * Displays the Change User Name dialog box, which allows the user to send a
+ * portion of the Notes® user ID to a Notes/Domino administrator, who can change
+ * the user name associated with the ID and return the ID to the user. The user
+ * then merges the updated portion back into the existing user ID.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILREQUESTNEWNAME.html|www.hcltechsw.com }
+ */
+function mailRequestNewName() {
+ return notesc.MailRequestNewName();
+}
+exports.mailRequestNewName = mailRequestNewName;
+/**
+ * Displays the Mail New Public Key Request dialog box, which allows the user to
+ * send a portion of his or her Notes/Domino ID to an administrator, who can create
+ * a new public key for the ID and return the ID to the user. The user then merges
+ * the updated portion back into the existing user ID.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILREQUESTNEWPUBLICKEY.html|www.hcltechsw.com }
+ */
+function mailRequestNewPublicKey() {
+ return notesc.MailRequestNewPublicKey();
+}
+exports.mailRequestNewPublicKey = mailRequestNewPublicKey;
+/**
+ * Indicates which option the user has selected for the "Save sent mail"setting in
+ * the User Preferences dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSAVEPREFERENCE.html|www.hcltechsw.com }
+ */
+function mailSavePreference() {
+ return notesc.MailSavePreference();
+}
+exports.mailSavePreference = mailSavePreference;
+/**
+ * Opens the user's mail database to the first unread document in the view to which
+ * the database was most recently open.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSCANUNREAD.html|www.hcltechsw.com }
+ */
+function mailScanUnread() {
+ return notesc.MailScanUnread();
+}
+exports.mailScanUnread = mailScanUnread;
+/**
+ * Displays the Mail Send dialog box, which lets the user choose whether or not to
+ * encrypt, sign, or send the selected memo.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSEND_COMMAND.html|www.hcltechsw.com }
+ */
+function mailSend() {
+ return notesc.MailSend(); // note: there is also a MailSend notes function in the miscellaneous category
+}
+exports.mailSend = mailSend;
+/**
+ * Displays the Mail Certificate Request dialog box. This lets the user send a safe
+ * copy of the Notes/Domino user ID to an administrator, who certifies and then
+ * returns it; the user then merges the updated safe copy back into the user ID.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSENDCERTIFICATEREQUEST.html|www.hcltechsw.com }
+ */
+function mailSendCertificateRequest() {
+ return notesc.MailSendCertificateRequest();
+}
+exports.mailSendCertificateRequest = mailSendCertificateRequest;
+/**
+ * Displays the User ID dialog box, where the user can define and send encryption
+ * keys. If the user's ID is password-protected, the user will be required to
+ * enter the password before being allowed access to the dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSENDENCRYPTIONKEY.html|www.hcltechsw.com }
+ */
+function mailSendEncryptionKey() {
+ return notesc.MailSendEncryptionKey();
+}
+exports.mailSendEncryptionKey = mailSendEncryptionKey;
+/**
+ * Displays the Mail Public Key dialog box. This lets the user send the public key
+ * to another user (typically to an administrator who can then paste the public key
+ * into that user's Person record in the Domino® Directory).
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSENDPUBLICKEY.html|www.hcltechsw.com }
+ */
+function mailSendPublicKey() {
+ return notesc.MailSendPublicKey();
+}
+exports.mailSendPublicKey = mailSendPublicKey;
+/**
+ * Indicates whether the user has selected "Sign sent mail" in the User Preferences
+ * dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSIGNPREFERENCE.html|www.hcltechsw.com }
+ */
+function mailSignPreference() {
+ return notesc.MailSignPreference();
+}
+exports.mailSignPreference = mailSignPreference;
+//# sourceMappingURL=mail.js.map
\ No newline at end of file
diff --git a/javadoc/math-trig.js.html b/javadoc/math-trig.js.html
new file mode 100644
index 00000000..079fcd4c
--- /dev/null
+++ b/javadoc/math-trig.js.html
@@ -0,0 +1,1497 @@
+Source: math-trig.js
"use strict";
+/**
+ * @file Math and Trigonometry
+ * @module math-trig
+ * @category Math & Trigonometry
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ln10 = exports.lcm = exports.iso = exports.int = exports.gcd = exports.floor = exports.factDouble = exports.fact = exports.even = exports.degrees = exports.decimal = exports.csch = exports.csc = exports.coth = exports.cot = exports.cosh = exports.combina = exports.combin = exports.ceilingPrecise = exports.ceilingMath = exports.ceiling = exports.base = exports.atanh = exports.asinh = exports.arabic = exports.aggregate = exports.acoth = exports.acot = exports.acosh = exports.tan = exports.sum = exports.sqrt = exports.sin = exports.sign = exports.round = exports.power = exports.pi = exports.min = exports.max = exports.log = exports.ln = exports.exp = exports.cos = exports.atan2 = exports.atan = exports.asin = exports.acos = exports.abs = exports._notes = exports._openFormula = void 0;
+exports.random = exports.modulo = exports.integer = exports.floatEq = exports.trunc = exports.tanh = exports.sumxmy2 = exports.sumx2Py2 = exports.sumx2My2 = exports.sumSq = exports.sumProduct = exports.sumIfs = exports.sumIf = exports.pow = exports.ne = exports.eq = exports.lte = exports.lt = exports.gte = exports.gt = exports.multiply = exports.divide = exports.minus = exports.add = exports.subTotal = exports.sqrtPi = exports.sinh = exports.seriesSum = exports.sech = exports.sec = exports.roundUp = exports.roundDown = exports.roman = exports.randBetween = exports.rand = exports.radians = exports.quotient = exports.product = exports.e = exports.odd = exports.multinomial = exports.mRound = exports.mod = exports.log10 = exports.log2E = exports.log10E = exports.ln2 = void 0;
+const tslib_1 = require("tslib");
+const openf = tslib_1.__importStar(require("../openformula/math-trig"));
+exports._openFormula = openf;
+const notesf = tslib_1.__importStar(require("../notes/math-trig"));
+exports._notes = notesf;
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const error = tslib_1.__importStar(require("../utils/error"));
+//-----------------------------
+// Rosetta math-trig - common functions (exist in both OpenFormula and Notes Formula)
+/**
+ * Returns the absolute (unsigned) value of one or more number(s).
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. The numbers whose absolute value is to be calculated.
+ * Any number whether positive or negative, whole or fractional, integer or real.
+ * @returns {number} Number or number list. The absolute values of value.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ABS.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ABS|www.oasis-open.org}
+ * @example rosetta.abs(-3); // returns 3
+ * @example rosetta.abs(-3,-4,-5); // returns [3,4,5]
+ */
+function abs(...value) {
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.ABS(n) : notesf.Abs(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.abs = abs;
+/**
+ * Returns the arccosine (inverse cosine) of a number using the cosine of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. A cosine of an angle, from -1 through 1.
+ * @returns {number} Number or number list. The trigonometric arccosine of value. An angle, in radians, from 0 through pi.
+ * This represents an angle between 0 and 180 degrees.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ACOS.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ACOS|www.oasis-open.org}
+ * @example rosetta.acos(.5); // returns 1.0471975511965979
+ * @example rosetta.acos(.5,.6,.7); // returns [1.0471975511965979, 0.9272952180016123, 0.7953988301841436]
+ */
+function acos(...value) {
+ if (!value.length) {
+ return API.isDefaultOpenFormula() ? openf.ACOS(0) : notesf.ACos(0);
+ }
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.ACOS(n) : notesf.ACos(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.acos = acos;
+/**
+ * Returns the arcsine (inverse sine) of a number using the sine of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. A sine of an angle, from -1 through 1.
+ * @returns {number} Number or number list. The trigonometric arcsine of value. An angle, in radians, from -pi/2 through pi/2.
+ * This represents an angle between -90 and 90 degrees.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ASIN.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ASIN|www.oasis-open.org}
+ * @example rosetta.asin(.5); // returns 0.5235987755982989
+ * @example rosetta.asin(.5,.6,.7); // returns [0.5235987755982989, 0.6435011087932844, 0.775397496610753]
+ */
+function asin(...value) {
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.ASIN(n) : notesf.ASin(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.asin = asin;
+/**
+ * Returns the arc (inverse) tangent using the tangent of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. A tangent of an angle, from -1 through 1.
+ * @returns {number} Number or number list. The trigonometric arctan of value. An angle, in radians, from -pi/2 through pi/2.
+ * This represents an angle between -90 and 90 degrees.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATAN.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ATAN|www.oasis-open.org}
+ * @example rosetta.atan(.5); // returns 0.4636476090008061
+ * @example rosetta.atan(.5,.6,.7); // returns [0.4636476090008061, 0.5404195002705842, 0.6107259643892086]
+ */
+function atan(...value) {
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.ATAN(n) : notesf.ATan(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.atan = atan;
+/**
+ * Returns the arc (inverse) tangent using the tangent x- and y-coordinates.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} x Number or number list. The denominator of the tangent value y / x.
+ * @param {number} y Number or number list. The numerator of the tangent value y / x.
+ * @returns {number} Number or number list. The trigonometric arctangent of y / x. An angle, in radians, from -pi through pi.
+ * This represents an angle between -180 and 180 degrees, depending on the sign of x and y.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ATAN2.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ATAN2|www.oasis-open.org}
+ * @example rosetta.atan2(1,1); // returns 0.7853981633974483
+ * @example rosetta.atan2([1,2,3],[1,2,3]); // returns [0.7853981633974483, 0.7853981633974483, 0.7853981633974483]
+ */
+function atan2(x, y) {
+ let list = [];
+ let xx = Array.isArray(x) ? x : [x];
+ let yy = Array.isArray(y) ? y : [y];
+ if (xx.length >= yy.length) {
+ list = xx.map((num, index) => index < yy.length ?
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.ATAN2(xx[index], yy[index]) : notesf.ATan2(xx[index], yy[index]) :
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.ATAN2(xx[index], yy[yy.length - 1]) : notesf.ATan2(xx[index], yy[yy.length - 1]));
+ }
+ else {
+ list = yy.map((num, index) => index < xx.length ?
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.ATAN2(xx[index], yy[index]) : notesf.ATan2(xx[index], yy[index]) :
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.ATAN2(xx[xx.length - 1], yy[index]) : notesf.ATan2(xx[xx.length - 1], yy[index]));
+ }
+ return list.length === 1 ? list[0] : list;
+}
+exports.atan2 = atan2;
+/**
+ * Given an angle in radians, returns the cosine of the angle. In a right triangle,
+ * the cosine of an acute angle is the ratio of the length of its adjacent side to
+ * the length of the hypotenuse.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} angle Number or number list. An angle measured in radians for which you want the cosine.
+ * @returns {number} Number or number list. The cosine of angle, from -1 to 1. Rounded to 15 decimal places.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_COS.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#COS|www.oasis-open.org}
+ * @example rosetta.cos(.5); // returns 0.8775825618903728
+ * @example rosetta.cos(.5,.6,.7); // returns [0.8775825618903728, 0.8253356149096783, 0.7648421872844885]
+ */
+function cos(...angle) {
+ const list = angle.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.COS(n) : notesf.Cos(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.cos = cos;
+/**
+ * Returns e (approximately 2.718282) raised to the power of a given number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} power Number or number list. The power to which you want to raise e.
+ * @returns {number} Number or number list. The number e raised to the power of the parameter. (this value can contain up to 14 decimal places).
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EXP.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#EXP|www.oasis-open.org}
+ * @example rosetta.exp(1); // returns 2.718281828459045
+ * @example rosetta.exp(1,1); // returns [2.718281828459045, 2.718281828459045]
+ */
+function exp(...power) {
+ if (API.isDefaultOpenFormula()) {
+ if (arguments.length < 1) {
+ return error.na;
+ }
+ if (arguments.length > 1) {
+ return error.error;
+ }
+ const list = power.map(n => n instanceof Error ? n : openf.EXP(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+ }
+ else {
+ return notesf.Exp(...power);
+ }
+}
+exports.exp = exp;
+/**
+ * Returns the natural log of a number. Natural logs use e (approximately 2.718282) as their base.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. May be any value greater than 0, and can contain up to 15 decimal places.
+ * @returns {number} Number or number list. The natural log of number.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LN.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#LN|www.oasis-open.org}
+ * @example rosetta.ln(5); // returns 1.6094379124341003
+ * @example rosetta.ln(5,6,7); // returns [1.6094379124341003, 1.791759469228055, 1.9459101490553132]
+ */
+function ln(...value) {
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.LN(n) : notesf.Ln(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.ln = ln;
+/**
+ * Returns the common logarithm (base 10) of any number greater than zero.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. Number who's common logarithm will be returned. Must be larger than zero.
+ * @param {number} [base] Number, optional. The base of the logarithm. If base is omitted, it is assumed to be 10.
+ * @returns {number} Number or number list. The log of number.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LOG.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#LOG|www.oasis-open.org}
+ * @example rosetta.log(4); // returns 0.602059991327962
+ * @example rosetta.log(5,6,7); // returns [0.6989700043360187, 0.7781512503836435, 0.8450980400142567]
+ */
+function log(value, base = 10) {
+ let list = [];
+ let num = Array.isArray(value) ? value : [value];
+ list = num.map(n => API.isDefaultOpenFormula() ? openf.LOG(n, base) : notesf.Log(n));
+ return list.length === 1 ? list[0] : list;
+}
+exports.log = log;
+/**
+ * Returns the largest number in a single list, or the larger of two numbers or number lists.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} values Number or number list.
+ * @returns {number} Number or number list. The larger of the values provided. If the
+ * parameters are number lists, NotesFormula Max returns a list that is the result of pair-wise
+ * computation on the list values and OpenFormula Max concats the lists and returns the number result.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAX.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#MAX|www.oasis-open.org}
+ * @example rosetta.max(4,5,6); // returns 6
+ * @example rosetta.max([5,8,6,7],[2,9,3]); // returns [5, 9, 6, 7] or 9
+ */
+function max(...values) {
+ return API.isDefaultOpenFormula() ? openf.MAX(...values) : notesf.Max(...values);
+}
+exports.max = max;
+/**
+ * Returns the smallest number in a single list, or the smaller of two numbers or
+ * number lists.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} values Number or number list.
+ * @returns {number} Number or number list. NotesFormula Max returns a list that is the result of pair-wise
+ * computation on the list values and OpenFormula Max concats the lists and returns the number result.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MIN.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#MIN|www.oasis-open.org}
+ * @example rosetta.min(4,5,6); // returns 4
+ * @example rosetta.min([5,8,6,7],[2,9,3]); // returns [2, 8, 3, 7] or 2
+ */
+function min(...values) {
+ return API.isDefaultOpenFormula() ? openf.MIN(...values) : notesf.Min(...values);
+}
+exports.min = min;
+/**
+ * Returns the constant value pi, accurate to fifteen decimal places.
+ * The value pi is the ratio of the circumference of a circle to its diameter.
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Returns the constant value pi, accurate to fifteen decimal places. 3.141592653589793
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PI.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#PI|www.oasis-open.org}
+ */
+function pi() {
+ return API.isDefaultOpenFormula() ? openf.PI() : notesf.Pi();
+}
+exports.pi = pi;
+/**
+ * Returns the result of a number raised to a power.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} base Number or number list. The value that you want raised to exponent. May be
+ * positive or negative.
+ * @param {number} exponent Number or number list. The power to which the base number is raised.
+ * @returns {number} Number or number list. The value of base raised to the power of exponent.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_POWER.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#POWER|www.oasis-open.org}
+ * @example rosetta.power(4,2); // returns 16
+ * @example rosetta.power([5,6],[2,2]); // returns [25, 36]
+ */
+function power(base, exponent) {
+ let list = [];
+ let bs = Array.isArray(base) ? base : [base];
+ let exp = Array.isArray(exponent) ? exponent : [exponent];
+ if (bs.length >= exp.length) {
+ list = bs.map((num, index) => index < exp.length ?
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.POWER(bs[index], exp[index]) : notesf.Power(bs[index], exp[index]) :
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.POWER(bs[index], exp[exp.length - 1]) : notesf.Power(bs[index], exp[exp.length - 1]));
+ }
+ else {
+ list = exp.map((num, index) => index < bs.length ?
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.POWER(bs[index], exp[index]) : notesf.Power(bs[index], exp[index]) :
+ num instanceof Error ? num : API.isDefaultOpenFormula() ? openf.POWER(bs[bs.length - 1], exp[index]) : notesf.Power(bs[bs.length - 1], exp[index]));
+ }
+ return list.length === 1 ? list[0] : list;
+}
+exports.power = power;
+/**
+ * Rounds the designated number to the nearest whole number; if an additional
+ * number is specified, it is used as the rounding factor.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Number or number list. Numbers to be rounded.
+ * @param {number} digits Number. Optional. The rounding factor to use. If you don't specify
+ * a factor, the number is rounded to the nearest whole number.
+ * @returns {number} Number or number list. The value of number, rounded to the specified factor or
+ * to the nearest whole number. If number is a list, each number in the list is
+ * rounded to the specified factor or to the nearest whole number.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ROUND.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#ROUND|www.oasis-open.org}
+ * @example rosetta.round(2.15,1); // returns 2.2
+ * @example rosetta.round([2.15,626.31],1); // returns [2.2, 626.3]
+ */
+function round(number, digits) {
+ let list = [];
+ let num = Array.isArray(number) ? number : [number];
+ // digits is optional but cannot be an array
+ if (Array.isArray(digits)) {
+ return new Error('#VALUE!');
+ }
+ // round to nearest whole number if no digits provided (digits = 0)
+ list = num.map(n => digits === undefined ?
+ API.isDefaultOpenFormula() ? openf.ROUND(n, 0) : notesf.Round(n) :
+ API.isDefaultOpenFormula() ? openf.ROUND(n, digits) : notesf.Round(n, digits));
+ return list.length === 1 ? list[0] : list;
+}
+exports.round = round;
+/**
+ * Indicates whether a number is positive, negative, or zero.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. The number whose sign you want to determine.
+ * @returns {number} Number or number list. May be any of the following values: signed number is
+ * negative, - 1, signed number is zero, 0, signed number is positive, 1
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SIGN_FUNCTION.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#SIGN|www.oasis-open.org}
+ * @example rosetta.sign(5); // returns 1
+ * @example rosetta.sign(5,-6,7); // returns [1, -1, 1]
+ */
+function sign(...value) {
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.SIGN(n) : notesf.Sign(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.sign = sign;
+/**
+ * Given an angle in radians, returns the sine of the angle. In a right triangle,
+ * the sine of an acute angle is the ratio of the length of its opposite side to
+ * the length of the hypotenuse.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} angle Number or number list. An angle expressed in radians for which you want the sine.
+ * @returns {number} Number or number list. The sine of angle, from -1 to 1. Rounded to 15 decimal places.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SIN.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#SIN|www.oasis-open.org}
+ * @example rosetta.sin(.5); // returns 0.479425538604203
+ * @example rosetta.sin(.5,.6,.7); // returns [0.479425538604203, 0.5646424733950354, 0.644217687237691]
+ */
+function sin(...angle) {
+ const list = angle.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.SIN(n) : notesf.Sin(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.sin = sin;
+/**
+ * Given a number, returns its positive square root.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. The number whose square root you want to find.
+ * The number must be positive, otherwise sqrt returns an error.
+ * @returns {number} Number or number list. The square root of the number.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SQRT.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#SQRT|www.oasis-open.org}
+ * @example rosetta.sqrt(25); // returns 5
+ * @example rosetta.sqrt(16,64,25); // returns [4, 8, 5]
+ */
+function sqrt(...value) {
+ const list = value.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.SQRT(n) : notesf.Sqrt(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.sqrt = sqrt;
+/**
+ * Adds a set of numbers or number lists.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. The numbers used to calculate the sum.
+ * @returns {number} Number that is the sum of the value numbers.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SUM.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#SUM|www.oasis-open.org}
+ * @example rosetta.sum(1, 2, 3); // returns 6
+ * @example rosetta.sum([1, 2, 3], [1, 4]); // returns 11
+ */
+function sum(...value) {
+ return API.isDefaultOpenFormula() ? openf.SUM(...value) : notesf.Sum(...value);
+}
+exports.sum = sum;
+/**
+ * Given an angle in radians, returns the tangent of the angle. In a right triangle
+ * the tangent of an acute angle is the ratio of the length of the opposite side to
+ * the length of the adjacent side.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} angle Number or number list. An angle expressed in radians for which you want the tangent.
+ * @returns {number} Number or number list. The tangent of angle, rounded to 15 decimal places.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_TAN.html|www.hcltechsw.com }
+ * and {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#TAN|www.oasis-open.org}
+ * @example rosetta.tan(.5); // returns 0.5463024898437905
+ * @example rosetta.tan(.5,.6,.7); // returns [0.5463024898437905, 0.6841368083416923, 0.8422883804630794]
+ */
+function tan(...angle) {
+ const list = angle.map(n => n instanceof Error ? n : API.isDefaultOpenFormula() ? openf.TAN(n) : notesf.Tan(n));
+ return list.length ? (list.length === 1 ? list[0] : list) : 0;
+}
+exports.tan = tan;
+//-----------------------------
+// Open Formula math-trig
+/**
+ * Returns the inverse hyperbolic cosine of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number equal to or greater than 1.
+ * @returns {number} Number that is the trigonometric inverse hyperbolic cosine of the number.
+ * @example rosetta.acosh(1); // returns 0
+ */
+function acosh(number) {
+ return openf.ACOSH(number);
+}
+exports.acosh = acosh;
+/**
+ * Returns the inverse cotangent of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Number that is the cotangent of the angle you want. This must be a real number.
+ * @returns {number} Number that is the trigonometric inverse cotangent of the number.
+ * @example rosetta.acot(1); // returns 0.7853981633974483
+ */
+function acot(number) {
+ return openf.ACOT(number);
+}
+exports.acot = acot;
+/**
+ * Returns the inverse hyperbolic cotangent of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number equal to or greater than 1.
+ * @returns {number} Number that is the trigonometric inverse hyperbolic cotangent of the number.
+ * @example rosetta.acoth(1); // returns Infinity
+ */
+function acoth(number) {
+ return openf.ACOTH(number);
+}
+exports.acoth = acoth;
+/**
+ * Returns an aggregate in a list or database.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} function_num A number 1 to 19 that specifies which function to use.
+ * @param {number} options A numerical value that determines which values to ignore in the
+ * evaluation range for the function. Note: The function will not ignore hidden rows,
+ * nested subtotals or nested aggregates if the array argument includes a calculation,
+ * for example: =AGGREGATE(14,3,A1:A100*(A1:A100>0),1)
+ * @param {number | number[]} ref1 The first numeric argument for functions that take multiple
+ * numeric arguments for which you want the aggregate value.
+ * @param {number} [ref2] Optional. Numeric arguments 2 to 253 for which you want the aggregate
+ * value. For functions that take an array, ref1 is an array, an array formula, or a reference
+ * to a range of values for which you want the aggregate value. Ref2 is a second argument that
+ * is required for certain functions.
+ * @returns {number} Number that is the aggregate of the input in a list or database.
+ * @example rosetta.aggregate(1, 4, [1, 2, 3]) // returns 2
+ */
+function aggregate(function_num, options, ref1, ref2) {
+ return openf.AGGREGATE(function_num, options, ref1, ref2);
+}
+exports.aggregate = aggregate;
+/**
+ * Converts a Roman number to Arabic, as a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {string} text String enclosed in quotation marks, an empty string (""), or a reference to a value containing text.
+ * @returns {number} Number that is the Arabic form of the given Roman number
+ * @example rosetta.arabic('X') // returns 10
+ */
+function arabic(text) {
+ return openf.ARABIC(text);
+}
+exports.arabic = arabic;
+/**
+ * Returns the inverse hyperbolic sine of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number.
+ * @returns {number} Number that is the trigonometric hyperbolic arcsine of the number.
+ * @example rosetta.asinh(0.5); // returns 0.48121182505960347
+ */
+function asinh(number) {
+ return openf.ASINH(number);
+}
+exports.asinh = asinh;
+/**
+ * Returns the inverse hyperbolic tangent of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number between 1 and -1.
+ * @returns {number} Number that is the trigonometric hyperbolic arctangent of the number.
+ * @example rosetta.atanh(1); // returns Infinity
+ */
+function atanh(number) {
+ return openf.ATANH(number);
+}
+exports.atanh = atanh;
+/**
+ * Converts a number into a text representation with the given radix (base).
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The number that you want to convert. Must be an integer greater than or equal to 0 and less than 2^53.
+ * @param {number} radix The base radix that you want to convert the number into. Must be an integer greater than or equal to 2 and less than or equal to 36.
+ * @param {number} [min_length] Optional. The minimum length of the returned string. Must be an integer greater than or equal to 0.
+ * @returns {number} Number that is the text representation with the given radix (base).
+ * @example rosetta.base(7, 2) // returns '111'
+ */
+function base(number, radix, min_length) {
+ return openf.BASE(number, radix, min_length);
+}
+exports.base = base;
+/**
+ * Rounds a number to the nearest integer or to the nearest multiple of significance.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The value you want to round.
+ * @param {number} significance The multiple to which you want to round.
+ * @param {number} [mode] Optional. For negative numbers, controls whether number is rounded toward or away from zero.
+ * @returns {number} Number that is the result of rounding the provided number
+ */
+function ceiling(number, significance, mode) {
+ return openf.CEILING.MATH(number, significance, mode);
+}
+exports.ceiling = ceiling;
+ceiling.math = ceiling;
+exports.ceilingMath = ceiling.math;
+ceiling.precise = ceiling;
+exports.ceilingPrecise = ceiling.precise;
+/**
+ * Returns the number of combinations for a given number of objects.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The number of items.
+ * @param {number} number_chosen The number of items in each combination.
+ * @returns {number} Number of combinations for the given number of items.
+ * @example rosetta.combin(3, 2) // returns 3
+ */
+function combin(number, number_chosen) {
+ return openf.COMBIN(number, number_chosen);
+}
+exports.combin = combin;
+/**
+ * Returns the number of combinations with repetitions for a given number of items.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The number of items. Must be greater than or equal to 0, and greater than or equal to Number_chosen.
+ * Non-integer values are truncated.
+ * @param {number} number_chosen The number of items in each combination. Must be greater than or equal to 0.
+ * Non-integer values are truncated.
+ * @returns {number} Number of combinations (with repititions) for the given number of items.
+ * @example rosetta.combina(3, 2) // returns 6
+ */
+function combina(number, number_chosen) {
+ return openf.COMBINA(number, number_chosen);
+}
+exports.combina = combina;
+/**
+ * Returns the hyperbolic cosine of the angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the hyperbolic cosine.
+ * @returns {number} Number that is the trigonometric hyperbolic cosine of angle
+ * @example rosetta.cosh(0); // returns 1
+ */
+function cosh(number) {
+ return openf.COSH(number);
+}
+exports.cosh = cosh;
+/**
+ * Returns the cotangent of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the cotangent.
+ * @returns {number} Number that is the trigonometric cotangent of the number.
+ * @example rosetta.cot(1); // returns 0.6420926159343306
+ */
+function cot(number) {
+ return openf.COT(number);
+}
+exports.cot = cot;
+/**
+ * Returns the hyperbolic cotangent of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the hyperbolic cotangent.
+ * @returns {number} Number that is the trigonometric hyperbolic cotangent of the number.
+ * @example rosetta.coth(1); // returns 1.3130352854993312
+ */
+function coth(number) {
+ return openf.COTH(number);
+}
+exports.coth = coth;
+/**
+ * Returns the cosecant of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the cosecant.
+ * @returns {number} Number that is the trigonometric cosecant of the number.
+ * @example rosetta.csc(1); // returns 1.1883951057781212
+ */
+function csc(number) {
+ return openf.CSC(number);
+}
+exports.csc = csc;
+/**
+ * Returns the hyperbolic cosecant of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the hyperbolic cosecant.
+ * @returns {number} Number that is the trigonometric hyperbolic cosecant of the number.
+ * @example rosetta.csch(1); // returns 0.8509181282393216
+ */
+function csch(number) {
+ return openf.CSCH(number);
+}
+exports.csch = csch;
+/**
+ * Converts a text representation of a number in a given base into a decimal number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {string} text The number as text
+ * @param {number} radix The number as the base. Radix must be an integer.
+ * @returns {number} The converted number as a decimal.
+ * @example rosetta.decimal('10', 2) // returns 2
+ */
+function decimal(text, radix) {
+ if (arguments.length < 1) {
+ return error.value;
+ }
+ return openf.DECIMAL(text, radix);
+}
+exports.decimal = decimal;
+/**
+ * Converts radians to degrees.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} angle The angle in radians that you want to convert.
+ * @returns {number} The converted angle in degrees.
+ * @example rosetta.degrees(Math.PI) // returns 180
+ */
+function degrees(angle) {
+ return openf.DEGREES(angle);
+}
+exports.degrees = degrees;
+/**
+ * Rounds a number up to the nearest even integer.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The value to round.
+ * @returns {number} The number rounded up to the nearest even integer.
+ * @example rosetta.even(3) // returns 4
+ */
+function even(number) {
+ return openf.EVEN(number);
+}
+exports.even = even;
+/**
+ * Returns the factorial of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The nonnegative number for which you want the factorial. If number is not an integer, it is truncated.
+ * @returns {number} The factorial of the given number.
+ * @example rosetta.fact(6) // returns 720
+ */
+function fact(number) {
+ return openf.FACT(number);
+}
+exports.fact = fact;
+/**
+ * Returns the double factorial of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The nonnegative number for which you want the double factorial. If number is not an integer, it is truncated.
+ * @returns {number} The double factorial of the given number.
+ * @example rosetta.factDouble(10) // returns 3840
+ */
+function factDouble(number) {
+ return openf.FACTDOUBLE(number);
+}
+exports.factDouble = factDouble;
+/**
+ * Rounds a number down, toward zero.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The numeric value you want to round.
+ * @param {number} significance The multiple to which you want to round.
+ * @returns {number} The number rounded down to the nearest multiple given.
+ * @example rosetta.floor(3.7, 2) // returns 2
+ */
+function floor(number, significance) {
+ return openf.FLOOR(number, significance);
+}
+exports.floor = floor;
+floor.math = function (number, significance, mode) {
+ return openf.FLOOR.MATH(number, significance, mode);
+};
+floor.precise = floor.math;
+/**
+ * Returns the greatest common divisor.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} numbers Number or number list. One is required, subsequent numbers are optional. 1 to 255 values for which you want the greatest common divisor. If any value is not an integer, it is truncated.
+ * @returns {number} Number that is the greatest common divisor.
+ * @see For further information, adapted from {@link http://rosettacode.org/wiki/Greatest_common_divisor#JavaScript|www.rosettacode.org }
+ * @example rosetta.gcd(24, 36) // returns 12
+ */
+function gcd(...numbers) {
+ return openf.GCD(...numbers);
+}
+exports.gcd = gcd;
+/**
+ * Truncates the values in a number or number list at the whole number, leaving off
+ * any decimals.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Number that is the value you want to truncate.
+ * @returns {number} Number that is the truncated value.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#INT|www.oasis-open.org}
+ * @example rosetta.int(5.5); // returns 5
+ */
+function int(number) {
+ return openf.INT(number);
+}
+exports.int = int;
+exports.iso = {
+ ceiling: ceiling
+};
+/**
+ * Returns the least common multiple.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} numbers Number or number list. One is required, subsequent numbers are optional. 1 to 255 values for which you want the least common multiple. If value is not an integer, it is truncated.
+ * @returns {number} Number that is the least common multiple.
+ * @example rosetta.lcm(5, 1, 2) // returns 10
+ */
+function lcm(...numbers) {
+ return openf.LCM(...numbers);
+}
+exports.lcm = lcm;
+/**
+ * Returns the natural logarithm of 10.
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Number, the natural log of 10.
+ * @example rosetta.ln10(); // returns 2.302585092994046
+ */
+function ln10() {
+ return openf.LN10();
+}
+exports.ln10 = ln10;
+/**
+ * Returns the natural logarithm of 2.
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Number, the natural log of 2.
+ * @example rosetta.ln2(); // returns 0.6931471805599453
+ */
+function ln2() {
+ return openf.LN2();
+}
+exports.ln2 = ln2;
+/**
+ * Returns the base-10 logarithm of e.
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Number, the base-10 logarithm of e.
+ * @example rosetta.log10E(); // returns 0.4342944819032518
+ */
+function log10E() {
+ return openf.LOG10E();
+}
+exports.log10E = log10E;
+/**
+ * Returns the base-2 logarithm of e.
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Number, the base-2 logarithm of e.
+ * @example rosetta.log2E(); // returns 1.4426950408889634
+ */
+function log2E() {
+ return openf.LOG2E();
+}
+exports.log2E = log2E;
+/**
+ * Returns the base-10 logarithm of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The positive real number for which you want the base-10 logarithm.
+ * @returns {number} Number that is the base-10 logarithm of the given number.
+ * @example rosetta.log10(10) // returns 1
+ */
+function log10(number) {
+ return openf.LOG10(number);
+}
+exports.log10 = log10;
+/**
+ * Returns the remainder of a division operation.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Number that is the dividend (numerator) to be divided.
+ * @param {number} divisor Number that is the divisor (denominator) to be divide dividend by.
+ * @returns {number} Number that is the remainder of dividend divided by divisor. If the
+ * parameters are number lists, mod returns a list that is the result of
+ * pair-wise computation on the list values.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#MOD|www.oasis-open.org}
+ * @example rosetta.mod(7,4); // returns 3
+ */
+function mod(number, divisor) {
+ return openf.MOD(number, divisor);
+}
+exports.mod = mod;
+/**
+ * Returns a number rounded to the desired multiple.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Number that is the value to round.
+ * @param {number} multiple Number that is the multiple to which you want to round the number.
+ * @returns {number} Number that is rounded to the desired multiple.
+ * @example rosetta.mRound(10, 3) // returns 9
+ */
+function mRound(number, multiple) {
+ return openf.MROUND(number, multiple);
+}
+exports.mRound = mRound;
+/**
+ * Returns the multinomial of a set of numbers.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} numbers Number or number list, one is required, subsequent numbers are optional. 1 to 255 values for which you want the multinomial.
+ * @returns {number} Number that is the multinomial of the set of given numbers.
+ * @example rosetta.multinomial(2, 3, 4) // 1260
+ */
+function multinomial(...numbers) {
+ return openf.MULTINOMIAL(...numbers);
+}
+exports.multinomial = multinomial;
+/**
+ * Rounds a number up to the nearest odd integer.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The value to round.
+ * @returns {number} The number rounded up to the nearest odd integer.
+ * @example rosetta.odd(4) // returns 5
+ */
+function odd(number) {
+ return openf.ODD(number);
+}
+exports.odd = odd;
+/**
+ * Returns the mathematical constant e (approximately 2.718282).
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Number that is the mathematical constant e
+ * @example rosetta.e() // returns 2.718282
+ */
+function e() {
+ return openf.E();
+}
+exports.e = e;
+/**
+ * Multiplies the arguments.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} numbers Number or number list that you want to multiply, up to a maximum of 255 arguments.
+ * @returns {number} Number that is the product of the arguments.
+ * @example rosetta.product([5, 15, 30]) // returns 2250
+ */
+function product(...numbers) {
+ return openf.PRODUCT(...numbers);
+}
+exports.product = product;
+/**
+ * Returns the integer portion of a division.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} numerator Number that is the dividend.
+ * @param {number} denominator Number that is the divisor.
+ * @returns {number} The quotient of the two arguments (integer portion).
+ * @example rosetta.quotient(4.5, 3.1) // returns 1
+ */
+function quotient(numerator, denominator) {
+ return openf.QUOTIENT(numerator, denominator);
+}
+exports.quotient = quotient;
+/**
+ * Converts degrees to radians.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} angle An angle in degrees that you want to convert.
+ * @returns {number} The converted angle in radians.
+ * @example rosetta.radians(180) // returns Math.PI
+ */
+function radians(angle) {
+ return openf.RADIANS(angle);
+}
+exports.radians = radians;
+/**
+ * Generates a random number between 0 and 1, inclusive.
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Random number between 0 and 1, inclusive.
+ * @see For further information, see {@link https://www.oasis-open.org/committees/download.php/16826/openformula-spec-20060221.html#RAND|www.oasis-open.org}
+ */
+function rand() {
+ return openf.RAND();
+}
+exports.rand = rand;
+/**
+ * Returns a random number between the numbers you specify.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} bottom The smallest integer RANDBETWEEN will return.
+ * @param {number} top The largest integer RANDBETWEEN will return.
+ * @returns {number} A random number between the numbers you specify.
+ * @example rosetta.randBetween(1, 10) // returns a number between 1 and 10 (inclusive)
+ */
+function randBetween(bottom, top) {
+ return openf.RANDBETWEEN(bottom, top);
+}
+exports.randBetween = randBetween;
+/**
+ * Converts an arabic numeral to roman, as text.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} arabic_numeral Number that is the Arabic numeral you want converted.
+ * @returns {string} String that is the Roman numeral form of the given Arabic number
+ * @example rosetta.roman(10) // returns 'X'
+ */
+function roman(arabic_numeral) {
+ return openf.ROMAN(arabic_numeral);
+}
+exports.roman = roman;
+/**
+ * Rounds a number down, toward zero.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number that you want rounded down.
+ * @param {number} digits The number of digits to which you want to round number.
+ * @returns {number} The number rounded down
+ * @example rosetta.roundDown(3.14159, 3) // returns 3.141
+ * @example rosetta.roundDown(-3.14159, 1) // returns -3.1
+ */
+function roundDown(number, digits) {
+ return openf.ROUNDDOWN(number, digits);
+}
+exports.roundDown = roundDown;
+/**
+ * Rounds a number up, away from zero.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number that you want rounded up.
+ * @param {number} digits The number of digits to which you want to round number.
+ * @returns {number} The number rounded up
+ * @example rosetta.roundUp(3.14159, 3) // returns 3.142
+ * @example rosetta.roundUp(-3.14159, 1) // returns -3.2
+ */
+function roundUp(number, digits) {
+ return openf.ROUNDUP(number, digits);
+}
+exports.roundUp = roundUp;
+/**
+ * Returns the secant of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the secant.
+ * @returns {number} Number that is the trigonometric secant of the number.
+ * @example rosetta.sec(1); // returns 1.1883951057781212
+ */
+function sec(number) {
+ return openf.SEC(number);
+}
+exports.sec = sec;
+/**
+ * Returns the hyperbolic secant of an angle.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the hyperbolic secant.
+ * @returns {number} Number that is the trigonometric hyberbolic secant of the number.
+ * @example rosetta.sech(1); // returns 0.6480542736638855
+ */
+function sech(number) {
+ return openf.SECH(number);
+}
+exports.sech = sech;
+/**
+ * Returns the sum of a power series based on the formula.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} x The input value to the power series.
+ * @param {number} power The initial power to which you want to raise x.
+ * @param {number} step The step by which to increase n for each term in the series.
+ * @param {number[]} coefficients A set of coefficients by which each successive power of x is multiplied.
+ * The number of values in coefficients determines the number of terms in the power series.
+ * For example, if there are three values in coefficients, then there will be three terms in the power series.
+ * @returns {number} Number that is the sum of the given power series
+ * @example rosetta.seriesSum( rosetta.pi() / 4, 0, 2,
+ * [ 1, -1 / rosetta.fact(2), 1 / rosetta.fact(4), -1 / rosetta.fact(6) ] )
+ * // returns 0.7071032148228457
+ */
+function seriesSum(x, power, step, coefficients) {
+ return openf.SERIESSUM(x, power, step, coefficients);
+}
+exports.seriesSum = seriesSum;
+/**
+ * Returns the hyperbolic sine of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number, angle measured in radians for which you want the hyperbolic sine.
+ * @returns {number} Number that is the trigonometric hyberbolic sine of the number.
+ * @example rosetta.sinh(1); // returns 1.1752011936438014
+ */
+function sinh(number) {
+ return openf.SINH(number);
+}
+exports.sinh = sinh;
+/**
+ * Returns the square root of (number * pi).
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The number by which pi is multiplied.
+ * @returns {number} Number that is the square root of (number * pi)
+ * @example rosetta.sqrtPi(3) // returns 3.0699801238394655
+ */
+function sqrtPi(number) {
+ return openf.SQRTPI(number);
+}
+exports.sqrtPi = sqrtPi;
+/**
+ * Returns a subtotal in a list or database.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} function_num Number 1-11 or 101-111 that specifies the function to use for the subtotal.
+ * 1-11 includes manually-hidden rows, while 101-111 excludes them; filtered-out values are always excluded.
+ * @param {number[]} ref1 Number or number list. The first named range or reference for which you want the subtotal.
+ * @returns {number} The subtotal of the of a list or database
+ * @example rosetta.subTotal(4, [1, 2, 3]) // returns 3 (max)
+ */
+function subTotal(function_num, ref1) {
+ return openf.SUBTOTAL(function_num, ref1);
+}
+exports.subTotal = subTotal;
+/**
+ * Returns the sum of the two given numbers.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} num1 Number that is the first addend.
+ * @param {number} num2 Number that is the second addend.
+ * @returns {number} The sum of the addends.
+ * @example rosetta.add(1.2, 4) // returns 5.2
+ */
+function add(num1, num2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.ADD(num1, num2);
+}
+exports.add = add;
+/**
+ * Returns the difference between the two given numbers.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} num1 Number that is being subtracted from.
+ * @param {number} num2 Number that is being subtracted.
+ * @returns {number} The difference between the two numbers.
+ * @example rosetta.minus(10, 4) // returns 6
+ */
+function minus(num1, num2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.MINUS(num1, num2);
+}
+exports.minus = minus;
+/**
+ * Returns the quotient of the two given numbers.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} dividend Number that is the dividend (numerator).
+ * @param {number} divisor Number that is the divisor (denominator).
+ * @returns {number} The quotient of the two numbers.
+ * @example rosetta.divide(10, 4) // returns 2.5
+ */
+function divide(dividend, divisor) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.DIVIDE(dividend, divisor);
+}
+exports.divide = divide;
+/**
+ * Returns the product of the two given numbers.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} factor1 Number that is the first factor being multiplied.
+ * @param {number} factor2 Number that is the second factor being multiplied.
+ * @returns {number} The product of the two numbers.
+ * @example rosetta.multiply(10, 4) // returns 40
+ */
+function multiply(factor1, factor2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.MULTIPLY(factor1, factor2);
+}
+exports.multiply = multiply;
+/**
+ * Returns whether the first number is greater than the second number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number|string} num1 The first number to compare.
+ * @param {number|string} num2 The second number to compare.
+ * @returns {boolean} True if num1 is greater than num2
+ * @example rosetta.gt(10, 4) // returns true
+ */
+function gt(num1, num2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.GT(num1, num2);
+}
+exports.gt = gt;
+/**
+ * Returns whether the first number is greater than or equal to the second number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number|string} num1 The first number to compare.
+ * @param {number|string} num2 The second number to compare.
+ * @returns {boolean} True if num1 is greater than or equal to num2
+ * @example rosetta.gte(10, 10) // returns true
+ */
+function gte(num1, num2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.GTE(num1, num2);
+}
+exports.gte = gte;
+/**
+ * Returns whether the first number is less than the second number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number|string} num1 The first number to compare.
+ * @param {number|string} num2 The second number to compare.
+ * @returns {boolean} True if num1 is less than num2
+ * @example rosetta.lt(10, 4) // returns false
+ */
+function lt(num1, num2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.LT(num1, num2);
+}
+exports.lt = lt;
+/**
+ * Returns whether the first number is less than or equal to the second number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number|string} num1 The first number to compare.
+ * @param {number|string} num2 The second number to compare.
+ * @returns {boolean} True if num1 is less than or equal to num2
+ * @example rosetta.lte(10, 10) // returns true
+ */
+function lte(num1, num2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.LTE(num1, num2);
+}
+exports.lte = lte;
+/**
+ * Returns whether the first number is equal to the second number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number|string} value1 The first value to compare.
+ * @param {number|string} value2 The second value to compare.
+ * @returns {boolean} True if num1 is equal to num2
+ * @example rosetta.eq(10, 10) // returns true
+ */
+function eq(value1, value2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.EQ(value1, value2);
+}
+exports.eq = eq;
+/**
+ * Returns whether the first number is not equal to the second number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number|string} value1 The first value to compare.
+ * @param {number|string} value2 The second value to compare.
+ * @returns {true} True if num1 is not equal to num2
+ * @example rosetta.ne(10, 10) // returns true
+ */
+function ne(value1, value2) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.NE(value1, value2);
+}
+exports.ne = ne;
+/**
+ * Returns the result of a number raised to a power.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} base The value that you want raised to exponent. May be positive or negative.
+ * @param {number} exponent The power to which the base number is raised.
+ * @returns {number} The value of base raised to the power of exponent.
+ * @example rosetta.pow(4,2); // returns 16
+ */
+function pow(base, exponent) {
+ if (arguments.length !== 2) {
+ return error.na;
+ }
+ return openf.POW(base, exponent);
+}
+exports.pow = pow;
+/**
+ * Adds the values specified by a given criteria.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {any[]} range The range of values that you want evaluated by criteria.
+ * Cells in each range must be numbers or names, arrays, or references that contain numbers.
+ * Blank and text values are ignored.
+ * @param {*} criteria The criteria in the form of a number, expression, a value reference, text,
+ * or a function that defines which values will be added.
+ * @param {number[]} [sum_range] Optional. The actual values to add, if you want to add values
+ * other than those specified in the range argument. If the sum_range argument is omitted,
+ * Excel adds the values that are specified in the range argument (the same values to which
+ * the criteria is applied). Sum_range should be the same size and shape as range. If it isn't,
+ * performance may suffer, and the formula will sum a range of values that starts with the
+ * first value in sum_range but has the same dimensions as range.
+ * @returns {number} The sum of the values specified by the given criteria.
+ * @example rosetta.sumIf([1, 2, 3], '>1') // returns 5
+ */
+function sumIf(range, criteria, sum_range) {
+ return openf.SUMIF(range, criteria, sum_range);
+}
+exports.sumIf = sumIf;
+/**
+ * Adds the values in a range that meet multiple criteria.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {any[]} values The range of values that you want evaluated.
+ * @returns {number} The sum of the values that meet the given criteria.
+ * @example rosetta.sumIfs([1, 2, 3], [4, 5, 6], '>4', [7, 8, 9], '<9') // returns 2
+ */
+function sumIfs(...values) {
+ return openf.SUMIFS(...values);
+}
+exports.sumIfs = sumIfs;
+/**
+ * Returns the sum of the products of corresponding array components.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {any[]} args The range of values that you want evaluated.
+ * @returns {number} The sum of the products of corresponding array components.
+ * @example rosetta.sumProduct([1, 4, 10], [0.55, 0.3, 0.1]) // returns 2.75
+ */
+function sumProduct(...args) {
+ if (!args || args.length === 0) {
+ return error.value;
+ }
+ return openf.SUMPRODUCT(...args);
+}
+exports.sumProduct = sumProduct;
+/**
+ * Returns the sum of the squares of the arguments.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} args Number or number list. One number is required, subsequent numbers are optional.
+ * 1 to 255 arguments for which you want the sum of the squares. You can also use a single array
+ * or a reference to an array instead of arguments separated by commas.
+ * @returns {number} The sum of the squares of the arguments.
+ * @example rosetta.sumSq([1, 2, 3]) // returns 14
+ */
+function sumSq(...args) {
+ return openf.SUMSQ(...args);
+}
+exports.sumSq = sumSq;
+/**
+ * Returns the sum of the difference of squares of corresponding values in two arrays.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number[]} array_x The first array or range of values.
+ * @param {number[]} array_y The second array or range of values.
+ * @returns {number} The sum of the difference of squares of corresponding values in two arrays.
+ * @example rosetta.sumx2My2([1, 2, 3], [4, 5, 6]) // returns -63
+ */
+function sumx2My2(array_x, array_y) {
+ return openf.SUMX2MY2(array_x, array_y);
+}
+exports.sumx2My2 = sumx2My2;
+/**
+ * Returns the sum of the sum of squares of corresponding values in two arrays.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number[]} array_x The first array or range of values.
+ * @param {number[]} array_y The second array or range of values.
+ * @returns {number} The sum of the difference of squares of corresponding values in two arrays.
+ * @example rosetta.sumx2Py2([1, 2, 3], [4, 5, 6]) // returns 91
+ */
+function sumx2Py2(array_x, array_y) {
+ return openf.SUMX2PY2(array_x, array_y);
+}
+exports.sumx2Py2 = sumx2Py2;
+/**
+ * Returns the sum of squares of differences of corresponding values in two arrays.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number[]} array_x The first array or range of values.
+ * @param {number[]} array_y The second array or range of values.
+ * @returns {number} The sum of squares of differences of corresponding values in two arrays.
+ * @example rosetta.sumxmy2([1, 2, 3], [4, 5, 6]) // returns 27
+ */
+function sumxmy2(array_x, array_y) {
+ return openf.SUMXMY2(array_x, array_y);
+}
+exports.sumxmy2 = sumxmy2;
+/**
+ * Returns the hyperbolic tangent of a number.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number Any real number.
+ * @returns {number} The hyperbolic tangent of the number.
+ * @example rosetta.tanh(0.5) // returns 0.46211715726000974
+ */
+function tanh(number) {
+ return openf.TANH(number);
+}
+exports.tanh = tanh;
+/**
+ * Truncates a number to an integer or a specified precision.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number The number you want to truncate.
+ * @param {number} [digits] Optional. A number specifying the precision of the truncation. The default value for num_digits is 0 (zero).
+ * @returns {number} The truncated for of the number with the given precision.
+ * @example rosetta.trunc(0.45) // returns 0
+ * @example rosetta.trunc(12.3456, 2) // returns 12.34
+ */
+function trunc(number, digits) {
+ return openf.TRUNC(number, digits);
+}
+exports.trunc = trunc;
+//-----------------------------
+// Notes @functions math-trig
+/**
+ * Compares two numbers for equality within a confidence range.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} number1 Number or number list. Any numeric value.
+ * @param {number} number2 Number or number list. Any numeric value.
+ * @param {number} confidence Number or number list. Optional (default is 0.0001).
+ * @returns {number} Returns 1 (true) if the difference of the numbers is less than the confidence
+ * range. Returns 0 (false) if the difference of the numbers exceeds or is equal to
+ * the confidence range.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FLOATEQ.html|www.hcltechsw.com }
+ * @example rosetta.floatEq(2.22, 2.24, 0.01); // returns false
+ * @example rosetta.floatEq(2.22, 2.24, 0.03); // returns true
+ * @example rosetta.floatEq([2.22, 2.24], [2.25, 2.26], 0.04); // returns true
+ */
+function floatEq(number1, number2, confidence) {
+ return notesf.FloatEq(number1, number2, confidence);
+}
+exports.floatEq = floatEq;
+/**
+ * Truncates the values in a number or number list at the whole number, leaving off
+ * any decimals.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} value Number or number list. The value(s) that is the value you want to truncate.
+ * @returns {number} Number or number list. The value(s) that is the truncated value.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_INTEGER.html|www.hcltechsw.com }
+ * @example rosetta.integer(5.5); // returns 5
+ * @example rosetta.integer(5.5,6.6,7.7); // returns [5, 6, 7]
+ */
+function integer(...value) {
+ return notesf.Integer(...value);
+}
+exports.integer = integer;
+/**
+ * Returns the remainder of a division operation.
+ *
+ * Category: Math and trigonometry
+ *
+ * @param {number} dividend Number or number list. The dividend (numerator) to be divided.
+ * @param {number} divisor Number or number list. The divisor (denominator) to be divide dividend by.
+ * @returns {number} Number or number list. The remainder of dividend divided by divisor. If the
+ * parameters are number lists, mod returns a list that is the result of
+ * pair-wise computation on the list values.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MODULO.html|www.hcltechsw.com }
+ * @example rosetta.modulo(7,4); // returns 3
+ * @example rosetta.modulo([7,5],[4,3]); // returns [3,2]);
+ */
+function modulo(dividend, divisor) {
+ return notesf.Modulo(dividend, divisor);
+}
+exports.modulo = modulo;
+/**
+ * Generates a random number between 0 and 1, inclusive by calling open formula RAND
+ *
+ * Category: Math and trigonometry
+ *
+ * @returns {number} Random number between 0 and 1, inclusive.
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_RANDOM.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented for NotesFormula with parameters
+ */
+function random() {
+ return notesf.Random();
+}
+exports.random = random;
+//-----------------------------
+// Notes @Commands math-trig
+//# sourceMappingURL=math-trig.js.map
\ No newline at end of file
diff --git a/javadoc/messaging.js.html b/javadoc/messaging.js.html
new file mode 100644
index 00000000..eada4713
--- /dev/null
+++ b/javadoc/messaging.js.html
@@ -0,0 +1,23 @@
+Source: messaging.js
\ No newline at end of file
diff --git a/javadoc/miscellaneous.js.html b/javadoc/miscellaneous.js.html
new file mode 100644
index 00000000..98d0aa9b
--- /dev/null
+++ b/javadoc/miscellaneous.js.html
@@ -0,0 +1,447 @@
+Source: miscellaneous.js
"use strict";
+/**
+ * @file Miscellaneous
+ * @module miscellaneous
+ * @category Miscellaneous
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.styleCycleKey = exports.smartIconsNextSet = exports.smartIconsFloating = exports.setCurrentLocation = exports.sendInstantMessage = exports.remoteDebugLotusScript = exports.pictureProperties = exports.pasteBitmapAsObject = exports.pasteBitmapAsBackground = exports.insertSubform = exports.goUpLevel = exports.formActions = exports.findFreeTimeDialog = exports.exitNotes = exports.execute = exports.exchangeUnreadMarks = exports.directories = exports.dialingRules = exports.debugLotusScript = exports.copySelectedAsTable = exports.clear = exports.checkCalendar = exports.calendarGoTo = exports.calendarFormat = exports.addToIMContactList = exports.addBookmark = exports.viewShowThisUnread = exports.verifyPassword = exports.validateInternetAddress = exports.setViewInfo = exports.setHTTPHeader = exports.setEnvironment = exports.postedCommand = exports.passwordQuality = exports.mailSend = exports.launchApp = exports.hashPassword = exports.environment = exports.enableAlarms = exports.dialogBox = exports.checkAlarms = exports._notes_vmx = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesf_base = tslib_1.__importStar(require("../notes/miscellaneous"));
+const notesf_vmx = tslib_1.__importStar(require("../notes/voltmx/miscellaneous"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const notesf = () => API.isDefaultFrameworkVoltMX() ? notesf_vmx : notesf_base;
+const notesc = notesf; // notes commands are exposed in the notes functions source file; this notesc is just for visual cue
+exports._notes = notesf_base;
+exports._notes_vmx = notesf_vmx;
+//-----------------------------
+// Notes @functions misc
+/**
+ * Triggers the alarm daemon to check for new alarms in the mail file.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CHECKALARMS.html|www.hcltechsw.com }
+ */
+function checkAlarms() {
+ return notesf().CheckAlarms();
+}
+exports.checkAlarms = checkAlarms;
+/**
+ * Brings up a dialog box that displays the current document (either open or
+ * selected in a view). The dialog box shares fields with the underlying document.
+ * The user interacts with the dialog box as usual, clicking OK or Cancel when
+ * finished.
+ *
+ * This function can be used with any form, but it's particularly useful with forms
+ * that contain a single table or layout region, because the user can interact with
+ * the table or layout region as if it were a dialog box.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DIALOGBOX.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function dialogBox() {
+ return notesf().DialogBox();
+}
+exports.dialogBox = dialogBox;
+/**
+ * Starts or stops the alarm daemon.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ENABLEALARMS.html|www.hcltechsw.com }
+ */
+function enableAlarms() {
+ return notesf().EnableAlarms();
+}
+exports.enableAlarms = enableAlarms;
+/**
+ * Sets or returns an environment variable stored in a formula.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ENVIRONMENT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function environment(key, value) {
+ return notesf().Environment(key, value);
+}
+exports.environment = environment;
+/**
+ * Encodes a string.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_HASHPASSWORD.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function hashPassword() {
+ return notesf().HashPassword();
+}
+exports.hashPassword = hashPassword;
+/**
+ * Launches the requested Domino® application.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_LAUNCHAPP_FUNCTION.html|www.hcltechsw.com }
+ */
+function launchApp() {
+ return notesf().LaunchApp();
+}
+exports.launchApp = launchApp;
+/**
+ * There are two ways to use @MailSend:
+ * - When used with no parameters, @MailSend mails the current document (the one
+ * being processed when the @function is evaluated) to the recipient designated
+ * in the document's SendTo field. The document must have a SendTo field.
+ * - When used with one or more parameters, @MailSend composes a new mail memo
+ * based on the information you supply in the arguments list, and sends it to the
+ * recipients listed in the sendTo, copyTo, and blindcopyTo arguments.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_MAILSEND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function mailSend() {
+ return notesf().MailSend();
+}
+exports.mailSend = mailSend;
+/**
+ * Evaluates the return value of a Password data type field with a number.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PASSWORDQUALITY.html|www.hcltechsw.com }
+ */
+function passwordQuality() {
+ return notesf().PasswordQuality();
+}
+exports.passwordQuality = passwordQuality;
+/**
+ * Indicates whether a field is locked by an administration policy and cannot be
+ * modified.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_POSTEDCOMMAND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function postedCommand() {
+ return notesf().PostedCommand();
+}
+exports.postedCommand = postedCommand;
+/**
+ * Sets an environment variable stored in the user's notes.ini file (Windows™,
+ * OS/2, and UNIX™) or Notes® Preferences file (Macintosh).
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETENVIRONMENT.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function setEnvironment(key, value) {
+ if (value === undefined) {
+ throw new Error('Insufficient arguments');
+ }
+ return notesf().SetEnvironment(key, value);
+}
+exports.setEnvironment = setEnvironment;
+/**
+ * In a Web application, sets the value of HTTP headers in the response being
+ * generated by the server for the browser client.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETHTTPHEADER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function setHTTPHeader() {
+ return notesf().SetHTTPHeader();
+}
+exports.setHTTPHeader = setHTTPHeader;
+/**
+ * In Standard Outline views, filters a view to display only documents from a
+ * specified category. In Calendar views, filters a view to display only documents
+ * that contain a specified string in a specified column.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETVIEWINFO.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function setViewInfo() {
+ return notesf().SetViewInfo();
+}
+exports.setViewInfo = setViewInfo;
+/**
+ * Validates an Internet address based on the RFC 822 or RFC 821 Address Format
+ * Syntax.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_VALIDATEINTERNETADDRESS_5866_OVER.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function validateInternetAddress() {
+ return notesf().ValidateInternetAddress();
+}
+exports.validateInternetAddress = validateInternetAddress;
+/**
+ * Compares two passwords.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_VERIFYPASSWORD.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function verifyPassword() {
+ return notesf().VerifyPassword();
+}
+exports.verifyPassword = verifyPassword;
+/**
+ * Changes a view to show only unread documents, or to show read and unread
+ * documents.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_VIEWSHOWTHISUNREAD.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function viewShowThisUnread() {
+ return notesf().ViewShowThisUnread();
+}
+exports.viewShowThisUnread = viewShowThisUnread;
+//-----------------------------
+// Notes @Commands misc
+/**
+ * Adds a bookmark with the specified URL or current object.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADDBOOKMARK_COMMAND.html|www.hcltechsw.com }
+ */
+function addBookmark() {
+ return notesc().AddBookmark();
+}
+exports.addBookmark = addBookmark;
+/**
+ * Adds a name or names to a personal group in the Instant Messaging Contact List.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_ADDTOIMCONTACTLIST.html|www.hcltechsw.com }
+ */
+function addToIMContactList() {
+ return notesc().AddToIMContactList();
+}
+exports.addToIMContactList = addToIMContactList;
+/**
+ * Changes the Calendar view to display one day, two days, one work week, one week,
+ * two work weeks, two weeks, one work month, one month, or one year.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CALENDARFORMAT.html|www.hcltechsw.com }
+ */
+function calendarFormat() {
+ return notesc().CalendarFormat();
+}
+exports.calendarFormat = calendarFormat;
+/**
+ * Goes to a particular date in a Calendar view.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CALENDARGOTO.html|www.hcltechsw.com }
+ */
+function calendarGoTo() {
+ return notesc().CalendarGoTo();
+}
+exports.calendarGoTo = calendarGoTo;
+/**
+ * Pops up a dialog box containing a one-day calendar view. The current database
+ * must contain a calendar view for this command to function properly.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CHECKCALENDAR_COMMAND.html|www.hcltechsw.com }
+ */
+function checkCalendar() {
+ return notesc().CheckCalendar();
+}
+exports.checkCalendar = checkCalendar;
+/**
+ * Performs the menu command Edit - Delete.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_CLEAR_COMMAND.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function clear() {
+ return notesc().Clear();
+}
+exports.clear = clear;
+/**
+ * Copies one or more selected entries as a table.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_COPYSELECTEDASTABLE.html|www.hcltechsw.com }
+ */
+function copySelectedAsTable() {
+ return notesc().CopySelectedAsTable();
+}
+exports.copySelectedAsTable = copySelectedAsTable;
+/**
+ * Puts Designer into debug mode, so that all LotusScript® scripts run in the
+ * debugger. The command is a toggle; selecting it again takes Notes® out of debug
+ * mode.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DEBUGLOTUSSCRIPT.html|www.hcltechsw.com }
+ */
+function debugLotusScript() {
+ return notesc().DebugLotusScript();
+}
+exports.debugLotusScript = debugLotusScript;
+/**
+ * Displays the Dialing Rules dialog box, which allows you to define dialing rules
+ * for a modem in a Location document in a Domino® Directory.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DIALINGRULES.html|www.hcltechsw.com }
+ */
+function dialingRules() {
+ return notesc().DialingRules();
+}
+exports.dialingRules = dialingRules;
+/**
+ * Displays the Directories dialog box which allows you to search for an address,
+ * view detailed information about an address entry, and add an entry to your
+ * Domino® Directory with the Directories dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_DIRECTORIES_COMMANDS_A_TO_Z.html|www.hcltechsw.com }
+ */
+function directories() {
+ return notesc().Directories();
+}
+exports.directories = directories;
+/**
+ * For two selected database replicas, marks the documents as read in one replica
+ * that are marked as read in the other.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EXCHANGEUNREADMARKS.html|www.hcltechsw.com }
+ */
+function exchangeUnreadMarks() {
+ return notesc().ExchangeUnreadMarks();
+}
+exports.exchangeUnreadMarks = exchangeUnreadMarks;
+/**
+ * Launches an application.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EXECUTE.html|www.hcltechsw.com }
+ */
+function execute() {
+ return notesc().Execute();
+}
+exports.execute = execute;
+/**
+ * Performs the menu command File - Exit (File - Quit on the Macintosh), which
+ * closes Notes/Domino and all its open windows.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_EXITNOTES_COMMAND.html|www.hcltechsw.com }
+ */
+function exitNotes() {
+ return notesc().ExitNotes();
+}
+exports.exitNotes = exitNotes;
+/**
+ * Opens the Free Time dialog box to allow searches for available meeting times.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FINDFREETIMEDIALOG.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function findFreeTimeDialog() {
+ return notesc().FindFreeTimeDialog();
+}
+exports.findFreeTimeDialog = findFreeTimeDialog;
+/**
+ * Displays the actions pane for the current form, subform, or Page. The command is
+ * a toggle; selecting it again hides the actions pane.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_FORMACTIONS.html|www.hcltechsw.com }
+ */
+function formActions() {
+ return notesc().FormActions();
+}
+exports.formActions = formActions;
+/**
+ * Displays the view containing the current document when the user closes that
+ * document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_GOUPLEVEL.html|www.hcltechsw.com }
+ */
+function goUpLevel() {
+ return notesc().GoUpLevel();
+}
+exports.goUpLevel = goUpLevel;
+/**
+ * Displays the Insert Subform dialog box, where you can select a subform to be
+ * inserted on a form.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_INSERTSUBFORM.html|www.hcltechsw.com }
+ */
+function insertSubform() {
+ return notesc().InsertSubform();
+}
+exports.insertSubform = insertSubform;
+/**
+ * Pastes a bitmap into the background of a navigator. All other objects in the
+ * navigator overlay the background bitmap.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PASTEBITMAPASBACKGROUND.html|www.hcltechsw.com }
+ */
+function pasteBitmapAsBackground() {
+ return notesc().PasteBitmapAsBackground();
+}
+exports.pasteBitmapAsBackground = pasteBitmapAsBackground;
+/**
+ * Pastes a bitmap into a navigator. The bitmap becomes a hotspot which can be
+ * edited like any other hotspot.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PASTEBITMAPASOBJECT.html|www.hcltechsw.com }
+ */
+function pasteBitmapAsObject() {
+ return notesc().PasteBitmapAsObject();
+}
+exports.pasteBitmapAsObject = pasteBitmapAsObject;
+/**
+ * Displays the Properties box for a bitmap in a rich text field.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_PICTUREPROPERTIES.html|www.hcltechsw.com }
+ */
+function pictureProperties() {
+ return notesc().PictureProperties();
+}
+exports.pictureProperties = pictureProperties;
+/**
+ * From the Notes® Remote Debugger client, opens the Select Debug Target dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REMOTEDEBUGLOTUSSCRIPT_COMMAND.html|www.hcltechsw.com }
+ */
+function remoteDebugLotusScript() {
+ return notesc().RemoteDebugLotusScript();
+}
+exports.remoteDebugLotusScript = remoteDebugLotusScript;
+/**
+ * Starts a chat with one or more users.
+ * @throws {Error} method not implemented
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SENDINSTANTMESSAGE.html|www.hcltechsw.com }
+ * @TODO this needs to be implemented
+ */
+function sendInstantMessage() {
+ return notesc().SendInstantMessage();
+}
+exports.sendInstantMessage = sendInstantMessage;
+/**
+ * Displays the Choose Location dialog box, where you can choose your current
+ * workstation location, such as Office, Island, or Travel.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SETCURRENTLOCATION.html|www.hcltechsw.com }
+ */
+function setCurrentLocation() {
+ return notesc().SetCurrentLocation();
+}
+exports.setCurrentLocation = setCurrentLocation;
+/**
+ * Makes the SmartIcons palette "float" so that users can move it around on the
+ * screen.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SMARTICONSFLOATING.html|www.hcltechsw.com }
+ */
+function smartIconsFloating() {
+ return notesc().SmartIconsFloating();
+}
+exports.smartIconsFloating = smartIconsFloating;
+/**
+ * Switches to display the next set of SmartIcons in the Icon bar.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_SMARTICONSNEXTSET.html|www.hcltechsw.com }
+ */
+function smartIconsNextSet() {
+ return notesc().SmartIconsNextSet();
+}
+exports.smartIconsNextSet = smartIconsNextSet;
+/**
+ * Cycles through the list of styles that have been defined for the current
+ * document, form, or page. This is the same as pressing F11. Each time you invoke
+ * StyleCycleKey, a different style goes into effect.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_STYLECYCLEKEY.html|www.hcltechsw.com }
+ */
+function styleCycleKey() {
+ return notesc().StyleCycleKey();
+}
+exports.styleCycleKey = styleCycleKey;
+//# sourceMappingURL=miscellaneous.js.map
\ No newline at end of file
diff --git a/javadoc/module-URL.html b/javadoc/module-URL.html
new file mode 100644
index 00000000..d4dad8f3
--- /dev/null
+++ b/javadoc/module-URL.html
@@ -0,0 +1,3 @@
+Module: URL
Returns specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web page.
Used for navigating, saving, and reloading a Uniform Resource Locator (URL) history list. The URL history list keeps track of all the Web pages you have visited. The history list is used for the Next and Previous buttons and for the Web Tours.
\ No newline at end of file
diff --git a/javadoc/module-admin.html b/javadoc/module-admin.html
new file mode 100644
index 00000000..54d24249
--- /dev/null
+++ b/javadoc/module-admin.html
@@ -0,0 +1,3 @@
+Module: admin
Displays the Choose Certifier ID dialog box, where you can select a Certifier ID file. After selecting a Certifier ID and entering its password, you select the user or server ID to be certified.
Displays the Choose Certifier ID dialog box, where you can select a Certifier ID file. After you select a Certifier ID and enter its password, Notes® displays the Choose ID to be Cross-Certified dialog box, which allows you to create a hierarchical cross certificate for an ID in another organization.
Displays the Choose Certifier ID dialog box, where you can select a Certifier ID file. After you select a Certifier ID and enter its password, Notes® displays the Cross Certify Key dialog box, which allows you to create a cross certificate for an ID in another organization using the numeric key associated with that ID.
Checks the current status of the Administration ECL in the name and address book and returns 1 (True) if the Administration ECL is locked and editing is prevented; otherwise returns 0 (False).
Displays the Choose ID File to Examine dialog box. After the administrator selects an ID, Notes/Domino displays the ID Properties box, which contains information about security basics and your identity.
Displays the Register Organization Certifier dialog box, where an administrator can create a hierarchical Certifier ID for an organization. After the administrator enters a name and password for the new Certifier ID, Notes® asks the user where to save the ID file and then creates the ID.
Prompts for the Certifier ID password and then displays the Register Organizational Unit Certifier dialog box, where the administrator can create a hierarchical Certifier ID for an organizational unit.
\ No newline at end of file
diff --git a/javadoc/module-agent.html b/javadoc/module-agent.html
new file mode 100644
index 00000000..fba4241c
--- /dev/null
+++ b/javadoc/module-agent.html
@@ -0,0 +1,3 @@
+Module: agent
Displays the log for the currently selected agent. The log contains information about when the agent last ran, what actions it performed, and when it finished running.
Runs all of the database's scheduled agents, regardless of when they are scheduled to run. The agents will then run as usual at their regularly scheduled times.
\ No newline at end of file
diff --git a/javadoc/module-attachment.html b/javadoc/module-attachment.html
new file mode 100644
index 00000000..bc294c2e
--- /dev/null
+++ b/javadoc/module-attachment.html
@@ -0,0 +1,3 @@
+Module: attachment
\ No newline at end of file
diff --git a/javadoc/module-compatibility.html b/javadoc/module-compatibility.html
new file mode 100644
index 00000000..75b5188a
--- /dev/null
+++ b/javadoc/module-compatibility.html
@@ -0,0 +1,3 @@
+Module: compatibility
\ No newline at end of file
diff --git a/javadoc/module-create.html b/javadoc/module-create.html
new file mode 100644
index 00000000..91f20e09
--- /dev/null
+++ b/javadoc/module-create.html
@@ -0,0 +1,3 @@
+Module: create
Creates a controlled access section on a form or subform. Unlike a regular section, a controlled access section has a formula to determine who can edit it.
Lets you create an ellipse in a navigator. After you invoke the command, the cursor changes to a crosshair when you start to drag the mouse in the design area. You create an ellipse by dragging the mouse until the ellipse is the size you want.
Lets you create a polygon in a navigator. After you invoke the command, the cursor changes to a crosshair when you start to drag the mouse in the design area. You create a polygon by clicking the mouse each time you want to start a new side. Double-click when you are done.
Lets you create a polyline in a navigator. After you invoke the command, the cursor changes to a crosshair when you start to drag the mouse in the design area. You create a polyline by clicking the mouse each time you want to start a new line. Double-click when you are done.
Lets you create a rectangle in a navigator. After you invoke the command, the cursor changes to a crosshair when you start to drag the mouse in the design area. You create a rectangle by dragging the mouse until the rectangle is the size you want.
Lets you create a rectangular hotspot in a navigator. After you invoke the command, the cursor changes to a crosshair when you start to drag the mouse in the design area. You create a rectangular hotspot by dragging the mouse until the rectangle is the size you want.
Lets you create a textbox in a navigator. After you invoke the command, the cursor changes to a crosshair when you start to drag the mouse in the design area. You create a textbox by dragging the mouse until the textbox is the size you want.
\ No newline at end of file
diff --git a/javadoc/module-database.html b/javadoc/module-database.html
new file mode 100644
index 00000000..d488c3ec
--- /dev/null
+++ b/javadoc/module-database.html
@@ -0,0 +1,3 @@
+Module: database
Finds the average of values in a given field from the records (rows) in a database that match a search criteria.
Parameters:
Name
Type
Description
database
Array
Range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
field
string
Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
criteria
Array
Range of values that contains the conditions you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
Average of the field's values from call to OpenFormula DAVERAGE function
Type:
number
(inner) dB2Schema(any)
Given the name of a database as a text string, returns a text string containing the DB2® schema of that database if it is a db2nsf database or the empty string if it is not a db2nsf database.
Returns a list of users, groups, and servers who currently have Manager access to the database. In a window title formula, only the name of the first manager listed in the ACL is displayed.
@DbManager does not work in selection formulas or column formulas.
Minimum value of the field's values matching search criteria from call to OpenFormula DMIN function
Type:
number
(inner) docChildren(any)
In a column or window title formula, returns the number of child documents or categories belonging to the current document or category. Only immediate responses count as children. For example, the responses to a main document are its children, but the responses to a response document are not.
In a column or window title formula, returns the number of descendant documents or subcategories belonging to the current document or category. Where @DocChildren only counts direct descendants, @DocDescendants counts all descendants, regardless of level.
In a column or window title formula, returns a string representing the entry number of the current document or category. For example, 2.3 indicates that the document is the third entry following the second entry.
In a column or window title formula, returns a string that represents the entry number of the parent view entry. Both the current view entry and the parent can be either documents or categories.
In a column or window title formula, returns a string that represents the total number of entries at the same level as a view entry (document or category). The returned total includes the document itself. For example, if the document is entry 8.2, and entries 8.1, 8.3, and 8.4 also exist, then there are four document siblings
For a particular database on the user's workspace, RenameDatabase locates a replica of that database (based on its replica ID) on the specified server, and replaces the database icon with that of the replica. The only change the user sees is that the server name has changed on the database icon.
Switches to the specified view or folder within the current database or, if a view or folder is not specified, displays the View menu so the user can select a view.
\ No newline at end of file
diff --git a/javadoc/module-date-time.html b/javadoc/module-date-time.html
new file mode 100644
index 00000000..15c5b457
--- /dev/null
+++ b/javadoc/module-date-time.html
@@ -0,0 +1,3 @@
+Module: date-time
(inner) adjust(dateOrDateList, years, months, days, hours, minutes, seconds) → {DateOrDateList}
Adjusts the specified time-date value by the number of years, months, days, hours, minutes, and/or seconds you specify. The amount of adjustment may be positive or negative.
Parameters:
Name
Type
Description
dateOrDateList
DateOrDateList
The Date or list of Dates you want to increment. This should be a single date, not a range.
Constructs the date from year, month, and day of month or translates numbers for the various components of time and date, then returns the time-date value.
Parameters:
Name
Type
Description
yearOrDateTime
number |Date |Array.<Date>
The year that you want to appear in the resulting date. You must specify an entire four-digit year. (For example, use 1996, not 96). Or Time-date or time-date list. For a time-date value such as @Now or [10/31/93 12:00:00], @Date removes the time portion of the value, leaving only the date.
month
number
Optional (when DateTime provided). The month that you want to appear in the resulting date. (For example, use 1 to specify January).
day
number
Optional (when DateTime provided). The day that you want to appear in the resulting date.
hour
number
Optional. The number of hours. This value will be truncated from the resulting date.
minute
number
Optional. The number of minutes. This value will be truncated from the resulting date.
second
number
Optional. The number of seconds. This value will be truncated from the resulting date.
Returns the string representation of the date and time from given text.
Parameters:
Name
Type
Description
date_text
string
Text that represents a date in an OpenFormula date format, or a reference to a value that contains text that represents a date in an OpenFormula date format.
Calculates the number of days between two dates based on a 360-day year.
Parameters:
Name
Type
Attributes
Description
endDate
string |number |Date
A date that represents the last, or ending, date of the period.
startDate
string |number |Date
A date that represents the first, or starting date of a given period.
method
string
<optional>
Optional. A logical value that specifies whether to use the U.S. or European method in the calculation. The default is FALSE.
FALSE U.S. (NASD) method. If the starting date is the last day of a month, it becomes equal to the 30th day of the same month. If the ending date is the last day of a month and the starting date is earlier than the 30th day of a month, the ending date becomes equal to the 1st day of the next month; otherwise the ending date becomes equal to the 30th day of the same month.
TRUE European method. Starting dates and ending dates that occur on the 31st day of a month become equal to the 30th day of the same month.
Constructs and returns a Date object from one of the following combination of time-date parameters: ( hour, minute, second ), ( year, month, day, hour, minute, second ), or Date object or array of Date objects, as per the notes formula Time function parameters.
Parameters:
Name
Type
Attributes
Description
args
any
<repeatable>
Date-time object or list of Dates, 6 Numbers representing the date-time, or 3 Numbers from 0 (zero) to 32767 representing the hour, minute, day. Any value greater than 23 will be divided by 24 and the remainder will be treated as the time value.
The decimal number of the time represented by a text string. The decimal number is a value ranging from 0 (zero) to 0.99988426, representing the times from 0:00:00 (12:00:00 AM) to 23:59:59 (11:59:59 P.M.).
Converts a date to a number representing where the week falls numerically with a year.
There are two systems used for this function:
System 1 The week containing January 1 is the first week of the year, and is numbered week 1.
System 2 The week containing the first Thursday of the year is the first week of the year, and is numbered as week 1. This system is the methodology specified in ISO 8601, which is commonly known as the European week numbering system.
Parameters:
Name
Type
Attributes
Description
date
string |number |Date
A date within the week.
return_type
number
<optional>
Optional. A number that determines on which day the week begins. The default is 1.
Return the serial number of the date before or after a specified number of workdays.
Parameters:
Name
Type
Attributes
Description
startDate
string |number |Error
A date that represents the first, or starting date of a given period
days
number
The number of nonweekend and nonholiday days before or after start_date. A positive value for days yields a future date; a negative value yields a past date.
holidays
Array
<optional>
An optional range of one or more dates to exclude from the working calendar, such as state and federal holidays and floating holidays.
\ No newline at end of file
diff --git a/javadoc/module-design.html b/javadoc/module-design.html
new file mode 100644
index 00000000..8a08ed03
--- /dev/null
+++ b/javadoc/module-design.html
@@ -0,0 +1,3 @@
+Module: design
Displays the Design Form Formula dialog box, where the user can define a formula that determines which form is used to display documents opened from a particular view or folder.
Displays the design pane and sets the Define control to View Selection, which allows you to define a selection formula to determine which documents are displayed in a view.
\ No newline at end of file
diff --git a/javadoc/module-directory.html b/javadoc/module-directory.html
new file mode 100644
index 00000000..4d5f3c49
--- /dev/null
+++ b/javadoc/module-directory.html
@@ -0,0 +1,3 @@
+Module: directory
In a Service Provider (xSP) environment, returns the name of the subdirectory for the company with which the currently authenticated user is registered. Notes/ Domino retrieves this information from the organization's certifier document.
\ No newline at end of file
diff --git a/javadoc/module-document.html b/javadoc/module-document.html
new file mode 100644
index 00000000..ef2fcfe4
--- /dev/null
+++ b/javadoc/module-document.html
@@ -0,0 +1,3 @@
+Module: document
Returns a number or a number list containing the length of each attachment to the current document. The number(s) returned are only approximations; the actual size(s) of the attachment(s) may be slightly different.
Returns a datetime that displays the date on which the file attachment associated with the current document was last modified. If the document contains more than one file attachment, returns the modification dates in a datetime list.
Returns the operating system file names of any files attached to a document. If there are multiple files attached, the names are returned as a multiple-value text list.
Returns the approximate number of bytes a truncated document lost during replication. The bytes are the total number of bytes per attachment, OLE object, large rich text field, or non-summary items that were too large, according to the replication settings for the database, to be replicated.
The universal ID, which uniquely identifies a document across all replicas of a database. In text format, the universal ID is a 32-character combination of hexadecimal digits (0-9, A-F).
The universal ID is also known as the unique ID or UNID.
In an agent that runs a formula, @HardDeleteDocument permanently removes the document currently being processed from the database if the database has soft deletions enabled. If the database does not have soft deletions enabled, @HardDeleteDocument performs the same action as @DeleteDocument.
A view you specify from which the user can select one or more documents. @pickList returns a column value from the selected document(s).
A dialog box, displaying information from all available Domino® Directories. The user can select one or more person, group, server, room, or resource names, and @pickList returns those names.
Assigns a value to a field stored within a document (use @set for temporary variables). This is similar to using the FIELD keyword, except that @setField can be used within another @function. If the field does not exist, this command creates it and applies the specified value to it.
Displays the Properties box for the currently selected Notes® object. For example, if a document is selected in a view, displays the document Properties box; if a field is selected on a form, displays the field Properties box.
\ No newline at end of file
diff --git a/javadoc/module-edit.html b/javadoc/module-edit.html
new file mode 100644
index 00000000..006cab12
--- /dev/null
+++ b/javadoc/module-edit.html
@@ -0,0 +1,3 @@
+Module: edit
Moves the insertion point in a document down by the number of lines you specify. If you don't specify a number, moves the insertion point down one line.
Performs the menu command Edit - Find/Replace without moving the focus to the editing window. This allows searches to take place when the focus is on the view or folder panes.
Indents a paragraph 1/4 inch. The entire paragraph is indented, as well as any paragraphs that are subsequently typed below it, until the user disables indenting.
Indents the first line of a paragraph 1/4 inch. The first line of the current paragraph is indented, as well as first lines of subsequently typed paragraphs, until the user disables indenting. (A carriage return defines a new paragraph.)
Moves the insertion point in a document, form, subform, or page to the left by the number of spaces you specify. If you don't specify a number, moves the insertion point one space to the left.
Makes selected text look like an Internet-style reply by prefixing each line with a greater-than sign and removing attachments and other objects. This sets each line of the message to a default length, preventing it from wrapping in unexpected places when sent to non-Notes users.
Displays the proportions of the selected graphic at the end of the screen. The user can size the picture by dragging the mouse in the appropriate direction.
Moves the insertion point in a document to the right by the number of spaces you specify. If you don't specify a number, moves the insertion point one space to the right.
Displays the Select by Date dialog box, where the user indicates which documents should be selected in the view or folder, according to the date they were created or last modified.
\ No newline at end of file
diff --git a/javadoc/module-engineering.html b/javadoc/module-engineering.html
new file mode 100644
index 00000000..7cad3f9c
--- /dev/null
+++ b/javadoc/module-engineering.html
@@ -0,0 +1,3 @@
+Module: engineering
The binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
The binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, bin2Hex uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, bin2Oct uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The decimal integer you want to convert. If number is negative, valid place values are ignored and dec2Bin returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, dec2Bin uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The decimal integer you want to convert. If number is negative, places is ignored and dec2Hex returns a 10-character (40-bit) hexadecimal number in which the most significant bit is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, dec2Hex uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The decimal integer you want to convert. If number is negative, places is ignored and dec2Oct returns a 10-character (30-bit) octal number in which the most significant bit is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, dec2Oct uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The hexadecimal number you want to convert. Number cannot contain more than 10 characters. The most significant bit of number is the sign bit (40th bit from the right). The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, hex2Bin uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The hexadecimal number you want to convert. Number cannot contain more than 10 characters (40 bits). The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
The hexadecimal number you want to convert. Number cannot contain more than 10 characters. The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, hex2Oct uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The octal number you want to convert. Number may not contain more than 10 characters. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
places
number
<optional>
The number of characters to use. If places is omitted, oct2Bin uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
The octal number you want to convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
The octal number you want to convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation
places
number
<optional>
The number of characters to use. If places is omitted, OCT2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
\ No newline at end of file
diff --git a/javadoc/module-file.html b/javadoc/module-file.html
new file mode 100644
index 00000000..4d031a1c
--- /dev/null
+++ b/javadoc/module-file.html
@@ -0,0 +1,3 @@
+Module: file
Closes the current Notes® window. If the document or design element in that window has not been saved, Notes® prompts the user to save it before closing.
Opens the specified database to the specified view, highlighting the first document whose value in the sort column matches the key. You specify a database using its server and file name.
Opens the specified database to the specified view, highlighting the first document whose value in the sort column matches the key. You specify a database using its replica ID, and Notes/Domino searches the workspace and all servers available in the current session to find a replica.
Displays the Page Setup dialog box (or, on the Macintosh, the File Print Margins dialog box), which allows you to specify print settings for the selected database.
\ No newline at end of file
diff --git a/javadoc/module-financial.html b/javadoc/module-financial.html
new file mode 100644
index 00000000..d47a6c99
--- /dev/null
+++ b/javadoc/module-financial.html
@@ -0,0 +1,3 @@
+Module: financial
a decimal number that results from converting a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. Or an error if the arguments are not formatted properly.
a fraction that results from converting dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. Or an error if he arguments arent formatted properly.
The total number of payment periods in an annuity.
pmt
number
The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. If pmt is omitted, you must include the pv argument.
pv
number
<optional>
0
Optional. The present value, or the lump-sum amount that a series of future payments is worth right now. If pv is omitted, it is assumed to be 0 (zero), and you must include the pmt argument.
type
number
<optional>
0
Optional. The number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
Returns the interest payment for an investment for a given period.
Category: Financial
Parameters:
Name
Type
Attributes
Default
Description
intrate
number
The interest rate per period.
period
number
The period for which you want to find the interest and must be in the range 1 to nper.
numper
number
The total number of payment periods in an annuity.
pvalue
number
The present value, or the lump-sum amount that a series of future payments is worth right now.
fvalue
number
<optional>
0
Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).
type
number
<optional>
0
Optional. The number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
the interest payment for an investment for a given period or an error if the arguments are not formatted properly.
Type:
number
(inner) irr(values, guessopt) → {number}
Returns the internal rate of return for a series of cash flows.
Category: Financial
Parameters:
Name
Type
Attributes
Default
Description
values
Array.<any>
An array or a reference to values that contain numbers for which you want to calculate the internal rate of return.
Values must contain at least one positive value and one negative value to calculate the internal rate of return.
IRR uses the order of values to interpret the order of cash flows. Be sure to enter your payment and income values in the sequence you want.
If an array or reference argument contains text, logical values, or empty values, those values are ignored.
guess
number
<optional>
0.1
Optional. A number that you guess is close to the result of IRR.
Microsoft Excel uses an iterative technique for calculating IRR. Starting with guess, IRR cycles through the calculation until the result is accurate within 0.00001 percent. If IRR can't find a result that works after 20 tries, the #NUM! error value is returned.
In most cases you do not need to provide guess for the IRR calculation. If guess is omitted, it is assumed to be 0.1 (10 percent).
If IRR gives the #NUM! error value, or if the result is not close to what you expected, try again with a different value for guess.
Returns the internal rate of return where positive and negative cash flows are financed at different rates.
Category: Financial
Parameters:
Name
Type
Description
values
Array.<any>
An array or a reference to values that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.
Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.
If an array or reference argument contains text, logical values, or empty values, those values are ignored; however, values with the value zero are included.
finance_intrate
number
The interest rate you pay on the money used in the cash flows.
reinvest_intrate
number
The interest rate you receive on the cash flows as you reinvest them.
the internal rate of return where positive and negative cash flows are financed at different rates or an error when the arguments arent formatted properly.
The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes.
pvalue
number
The present value, or the lump-sum amount that a series of future payments is worth right now.
fvalue
number
<optional>
0
Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).
type
number
<optional>
0
Optional. The number 0 or 1 and indicates when payments are due.
the number of periods for an invesment or an error if the arguments are not formatted properly.
Type:
number
(inner) npv(drate, …values) → {number}
Returns the net present value of an investment based on a series of periodic cash flows and a discount rate.
Category: Financial
Parameters:
Name
Type
Attributes
Description
drate
number
The rate of discount over the length of one period.
values
Array.<number>
<repeatable>
value1, value2, ... Value1 is required, subsequent values are optional. 1 to 254 arguments representing the payments and income.
value1, value2, ... must be equally spaced in time and occur at the end of each period.
NPV uses the order of value1, value2, ... to interpret the order of cash flows. Be sure to enter your payment and income values in the correct sequence.
Arguments that are empty values, logical values, or text representations of numbers, error values, or text that cannot be translated into numbers are ignored.
If an argument is an array or reference, only numbers in that array or reference are counted. Empty values, logical values, text, or error values in the array or reference are ignored.
The present value, or the total amount that a series of future payments is worth now; also known as the principal.
fvalue
number
<optional>
0
Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
type
number
<optional>
0
Optional. The number 0 (zero) or 1 and indicates when payments are due.
Returns the payment on the principal for an investment for a given period.
Category: Financial
Parameters:
Name
Type
Attributes
Default
Description
intrate
number
The interest rate per period.
period
number
Specifies the period and must be in the range 1 to nper.
numper
number
The total number of payment periods in an annuity.
pvalue
number
The present value — the total amount that a series of future payments is worth now.
fvalue
number
<optional>
0
Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
type
number
<optional>
0
Optional. The number 0 or 1 and indicates when payments are due.
The interest rate per period. For example, if you obtain an automobile loan at a 10 percent annual interest rate and make monthly payments, your interest rate per month is 10%/12, or 0.83%. You would enter 10%/12, or 0.83%, or 0.0083, into the formula as the rate.
periods
number
The total number of payment periods in an annuity. For example, if you get a four-year car loan and make monthly payments, your loan has 4*12 (or 48) periods. You would enter 48 into the formula for nper.
payment
number
The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes. For example, the monthly payments on a $10,000, four-year car loan at 12 percent are $263.33. You would enter -263.33 into the formula as the pmt. If pmt is omitted, you must include the fv argument.
fvalue
number
0
Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0). For example, if you want to save $50,000 to pay for a special project in 18 years, then $50,000 is the future value. You could then make a conservative guess at an interest rate and determine how much you must save each month. If fv is omitted, you must include the pmt argument.
type
number
<optional>
0
Optional. The number 0 or 1 and indicates when payments are due.
Returns the interest rate per period of an annuity.
Category: Financial
Parameters:
Name
Type
Attributes
Default
Description
periods
number
The total number of payment periods in an annuity.
payment
number
The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes. If pmt is omitted, you must include the fv argument.
pvalue
number
The present value — the total amount that a series of future payments is worth now.
fvalue
number
<optional>
0
Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0). If fv is omitted, you must include the pmt argument.
type
number
<optional>
Optional. The number 0 or 1 and indicates when payments are due.
guess
number
<optional>
Optional. Your guess for what the rate will be. If you omit guess, it is assumed to be 10 percent. If RATE does not converge, try different values for guess. RATE usually converges if guess is between 0 and 1.
If you omit guess, it is assumed to be 10 percent.
If RATE does not converge, try different values for guess. RATE usually converges if guess is between 0 and 1.
Returns the depreciation of an asset for a specified or partial period by using a declining balance method.
Category: Financial
Parameters:
Name
Type
Description
cost
*
The initial cost of the asset.
salvage
*
The value at the end of the depreciation (sometimes called the salvage value of the asset). This value can be 0.
life
*
The number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
start_period
*
The starting period for which you want to calculate the depreciation. Start_period must use the same units as life.
end_period
*
The ending period for which you want to calculate the depreciation. End_period must use the same units as life.
factor
*
Optional. The rate at which the balance declines. If factor is omitted, it is assumed to be 2 (the double-declining balance method). Change factor if you do not want to use the double-declining balance method. For a description of the double-declining balance method, see DDB.
no_switch
*
Optional. A logical value specifying whether to switch to straight-line depreciation when depreciation is greater than the declining balance calculation.
If no_switch is TRUE, Microsoft Excel does not switch to straight-line depreciation even when the depreciation is greater than the declining balance calculation.
If no_switch is FALSE or omitted, Excel switches to straight-line depreciation when depreciation is greater than the declining balance calculation.
Returns the internal rate of return for a schedule of cash flows that is not necessarily periodic.
Category: Financial
Parameters:
Name
Type
Attributes
Default
Description
cash_flows
Array.<number>
A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive and one negative value.
paydates
Array.<Date> |Array.<number> |Array.<string>
A schedule of payment dates that corresponds to the cash flow payments. Dates may occur in any order. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. .
guess
number
<optional>
0.1
Optional. A number that you guess is close to the result of XIRR.
Returns the net present value for a schedule of cash flows that is not necessarily periodic.
Category: Financial
Parameters:
Name
Type
Description
disrate
number
The discount rate to apply to the cash flows.
cash_flows
Array.<number>
A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive value and one negative value.
paydates
Array.<Date> |Array.<number> |Array.<string>
A schedule of payment dates that corresponds to the cash flow payments. The first payment date indicates the beginning of the schedule of payments. All other dates must be later than this date, but they may occur in any order.
\ No newline at end of file
diff --git a/javadoc/module-folder.html b/javadoc/module-folder.html
new file mode 100644
index 00000000..8768250f
--- /dev/null
+++ b/javadoc/module-folder.html
@@ -0,0 +1,3 @@
+Module: folder
\ No newline at end of file
diff --git a/javadoc/module-formula.html b/javadoc/module-formula.html
new file mode 100644
index 00000000..29985e77
--- /dev/null
+++ b/javadoc/module-formula.html
@@ -0,0 +1,3 @@
+Module: formula
Executes a Notes/Domino command. Most of the standard menu commands can be executed using @Command. In addition, a number of specialized commands are available. In a formula, any command invoked using @Command runs in the order you specify in the formula. This means that any changes made by the command, such as inserting text into a field, affect the rest of the formula (see exceptions).
In the context of RosettaJS, the @Command is a Notes @Formula function that does not exist in the functions of the Notes @Formula language but rather an
At run-time, compiles and runs each element in a text expression as a formula. Returns the result of the last formula expression in the list or an error if an error is generated by any of the formula expressions in the list.
Updates the context of a formula to the Notes® client window currently being accessed by the code. For example, if the code accesses a new form called "Response" by using @Command([Compose]:"Response", @UpdateFormulaContext switches the context of the formula to this new form. Any subsequent functions in the code execute in the context of the Response document, not the current document.
\ No newline at end of file
diff --git a/javadoc/module-help.html b/javadoc/module-help.html
new file mode 100644
index 00000000..80dc94d4
--- /dev/null
+++ b/javadoc/module-help.html
@@ -0,0 +1,3 @@
+Module: help
Displays the About This Database or database policy document for the current database (which typically explains the purpose of the application, as well as its intended audience).
Displays the Using This Database document for the current database. The Using This Database document typically provides pointers on how to use an application's forms and views.
\ No newline at end of file
diff --git a/javadoc/module-information.html b/javadoc/module-information.html
new file mode 100644
index 00000000..4bea1287
--- /dev/null
+++ b/javadoc/module-information.html
@@ -0,0 +1,3 @@
+Module: information
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
Returns TRUE if the value is any error value except #N/A.
Category: Information
Parameters:
Name
Type
Description
value
*
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
Returns TRUE if the value is the #N/A error value.
Category: Information
Parameters:
Name
Type
Description
value
*
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
returns true if the value being evaluated is equal to error.na, false if not;
Type:
boolean
Examples
ISNA(error.na); // returns true.
ISNA(1); // returns false.
(inner) isNonText(value) → {boolean}
Returns TRUE if the value is not text.
Category: Information
Parameters:
Name
Type
Description
value
*
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
Returns TRUE if the value is a reference. Category: Information
Parameters:
Name
Type
Description
value
*
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
Returns the URL and port number of the LDAP listener in the current domain. Notes® looks for this information in several places, following this search sequence:
Searches on the current server.
Searches for the notes.ini variable labeled LDAPSERVER=.
Queries the administration server, which runs the LDAP service automatically, by default.
Allows you to generate an error condition within an expression. This is useful if you want to evaluate the current values in several fields and need to know if an error has occurred in the entry of any of them.
Returns the sheet number of the referenced sheet. Category: Information
Parameters:
Name
Type
Description
value
*
Optional. Value is the name of a sheet or a reference for which you want the sheet number. If value is omitted, SHEET returns the number of the sheet that contains the function.
Returns the number of sheets in a reference. Category: Information
Parameters:
Name
Type
Description
reference
*
Optional. Reference is a reference for which you want to know the number of sheets it contains. If Reference is omitted, SHEETS returns the number of sheets in the workbook that contains the function.
\ No newline at end of file
diff --git a/javadoc/module-layout.html b/javadoc/module-layout.html
new file mode 100644
index 00000000..8f1115c1
--- /dev/null
+++ b/javadoc/module-layout.html
@@ -0,0 +1,3 @@
+Module: layout
\ No newline at end of file
diff --git a/javadoc/module-lists.html b/javadoc/module-lists.html
new file mode 100644
index 00000000..9ff86d7e
--- /dev/null
+++ b/javadoc/module-lists.html
@@ -0,0 +1,3 @@
+Module: lists
Calculates the number of text, number, or time-date values in a list. This function always returns a number to indicate the number of entries in the list.
This function is similar to @Elements, except that it returns the number 1 instead of 0, when the value it is evaluating is not a list or is a null string.
Calculates the number of text, number, or time-date values in a list. This function always returns a number to indicate the number of entries in the list.
Returns the value that appears in the number position. If the number is greater than the number of values, @Select returns the last value in the list. If the value in the number position is a list, returns the entire list contained within the value.
Searches a list from beginning to end and returns the number values you specify. If you specify a negative number, @Subset searches the list from end to beginning, but the result is ordered as from the beginning of the list.
Without a parameter, returns a random, unique text value. With a parameter, removes duplicate values from a text list by returning only the first occurrence of each member of the list.
\ No newline at end of file
diff --git a/javadoc/module-logical.html b/javadoc/module-logical.html
new file mode 100644
index 00000000..7c607611
--- /dev/null
+++ b/javadoc/module-logical.html
@@ -0,0 +1,3 @@
+Module: logical
rosettajs.false(); // returns false (openf) or 0 (notesf)
(static) for()
Executes one or more statements iteratively while a condition remains true. Executes an initialization statement. Checks the condition before executing the statements and executes an increment statement after executing the statements.
Returns a value you specify if a formula evaluates to an error; otherwise, returns the result of the formula.
Parameters:
Name
Type
Description
value
any
The argument that is checked for an error.
value_if_error
any
The value to return if the formula evaluates to an error. The following error types are evaluated: #N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!.
The value that corresponds to the first TRUE condition.
Type:
any
Example
rosettajs.ifs(false, 1, true, 2) // returns 2
(static) isNull(value) → {boolean}
Tests for a null value. Returns true only if a value is a single text value that is null, otherwise it returns false. This function also returns false if the value is an error.
True if any one of the arguments are true. False if all values are false.
Type:
boolean
Example
rosettajs.or(true, false) // returns true
(static) return(value) → {any}
Immediately stops the execution of a formula and returns the specified value. This is useful when you only want the remainder of the formula to be executed only if certain conditions are True.
Evaluates an expression against a list of values and returns the result corresponding to the first matching value. If there is no match, an optional default value may be returned.
logical1, logical2,… Logical 1 is required, subsequent logical values are optional. 1 to 254 conditions you want to test that can be either TRUE or FALSE, and can be logical values, arrays, or references.
\ No newline at end of file
diff --git a/javadoc/module-lookup-reference.html b/javadoc/module-lookup-reference.html
new file mode 100644
index 00000000..099b1dbc
--- /dev/null
+++ b/javadoc/module-lookup-reference.html
@@ -0,0 +1,3 @@
+Module: lookup-reference
Specifies which value argument is selected. Index_num must be a number between 1 and 254, or a formula or reference to a value containing a number between 1 and 254. If index_num is 1, CHOOSE returns value1; if it is 2, CHOOSE returns value2; and so on. If index_num is less than 1 or greater than the number of the last value in the list, CHOOSE returns the #VALUE! error value. If index_num is a fraction, it is truncated to the lowest integer before being used.
If index_num is 1, CHOOSE returns value1; if it is 2, CHOOSE returns value2; and so on.
If index_num is less than 1 or greater than the number of the last value in the list, CHOOSE returns the #VALUE! error value.
If index_num is a fraction, it is truncated to the lowest integer before being used.
index_num
number
the index of the value to return.
args
*
<repeatable>
value1, value2, ... Value 1 is required, subsequent values are optional. 1 to 254 value arguments from which CHOOSE selects a value or an action to perform based on index_num. The arguments can be numbers, value references, defined names, formulas, functions, or text.
Looks in the top row of an array and returns the value of the indicated value.
Category: Lookup and reference
Parameters:
Name
Type
Attributes
Description
lookup_value
*
The value to be found in the first row of the table. Lookup_value can be a value, a reference, or a text string.
table_array
Array.<Array.<any>>
A table of information in which data is looked up. Use a reference to a range or a range name.
row_index_num
number
The row number in table_array from which the matching value will be returned. A row_index_num of 1 returns the first row value in table_array, a row_index_num of 2 returns the second row value in table_array, and so on. If row_index_num is less than 1, HLOOKUP returns the #VALUE! error value; if row_index_num is greater than the number of rows on table_array, HLOOKUP returns the #REF! error value.
range_lookup
boolean
<optional>
Optional. A logical value that specifies whether you want HLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, HLOOKUP will find an exact match. If one is not found, the error value #N/A is returned.
Uses an index to choose a value from a reference or array.
Category: Lookup and reference
Parameters:
Name
Type
Attributes
Description
array
Array.<any>
A range of values or an array constant.
If array contains only one row or column, the corresponding row_num or column_num argument is optional.
If array has more than one row and more than one column, and only row_num or column_num is used, INDEX returns an array of the entire row or column in array.
row_num
number
Required, unless column_num is present. Selects the row in array from which to return a value. If row_num is omitted, column_num is required.
column_num
number
<optional>
Optional. Selects the column in array from which to return a value. If column_num is omitted, row_num is required.
A value that LOOKUP searches for in an array. The lookup_value argument can be a number, text, a logical value, or a name or reference that refers to a value.
If LOOKUP can't find the value of lookup_value, it uses the largest value in the array that is less than or equal to lookup_value.
If the value of lookup_value is smaller than the smallest value in the first row or column (depending on the array dimensions), LOOKUP returns the #N/A error value.
array
Array.<any>
A range of values that contains text, numbers, or logical values that you want to compare with lookup_value. The array form of LOOKUP is very similar to the HLOOKUP and VLOOKUP functions. The difference is that HLOOKUP searches for the value of lookup_value in the first row, VLOOKUP searches in the first column, and LOOKUP searches according to the dimensions of array.
result_array
Array.<any>
<optional>
Optional. A range that contains only one row or column. The result_array argument must be the same size as lookup_value. It has to be the same size.
The value that you want to match in lookup_array. For example, when you look up someone's number in a telephone book, you are using the person's name as the lookup value, but the telephone number is the value you want.The lookup_value argument can be a value (number, text, or logical value) or a value reference to a number, text, or logical value.
lookup_array
Array.<any>
The range of values being searched.
match_type
number
1
Optional. The number -1, 0, or 1. The match_type argument specifies how Excel matches lookup_value with values in lookup_array. The default value for this argument is 1.
An array or range of values on a worksheet that you want to transpose. The transpose of an array is created by using the first row of the array as the first column of the new array, the second row of the array as the second column of the new array, and so on. If you're not sure of how to enter an array formula, see Create an array formula.
Looks in the first column of an array and moves across the row to return the value of a value.
Category: Lookup and reference
Parameters:
Name
Type
Attributes
Description
lookup_value
*
The value to be found in the first row of the table. Lookup_value can be a value, a reference, or a text string.
table_array
Array.<Array.<any>>
A table of information in which data is looked up. Use a reference to a range or a range name.
col_index_num
number
The row number in table_array from which the matching value will be returned. A row_index_num of 1 returns the first row value in table_array, a row_index_num of 2 returns the second row value in table_array, and so on. If row_index_num is less than 1, VLOOKUP returns the #VALUE! error value; if row_index_num is greater than the number of rows on table_array, VLOOKUP returns the #REF! error value.
range_lookup
boolean
<optional>
Optional. A logical value that specifies whether you want VLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, VLOOKUP will find an exact match. If one is not found, the error value #N/A is returned.
\ No newline at end of file
diff --git a/javadoc/module-mail.html b/javadoc/module-mail.html
new file mode 100644
index 00000000..e3a03131
--- /dev/null
+++ b/javadoc/module-mail.html
@@ -0,0 +1,3 @@
+Module: mail
Creates and displays a blank mail document. Notes/Domino uses the default form for the user's mail database. This is a Memo document unless the user has changed it.
Displays the Choose ID to be Cross-Certified dialog box, which allows an administrator to send a safe copy of a Certifier ID to another administrator, who can certify it with a different Certifier ID to create a cross certificate.
Displays the Change User Name dialog box, which allows the user to send a portion of the Notes® user ID to a Notes/Domino administrator, who can change the user name associated with the ID and return the ID to the user. The user then merges the updated portion back into the existing user ID.
Displays the Mail New Public Key Request dialog box, which allows the user to send a portion of his or her Notes/Domino ID to an administrator, who can create a new public key for the ID and return the ID to the user. The user then merges the updated portion back into the existing user ID.
Displays the Mail Certificate Request dialog box. This lets the user send a safe copy of the Notes/Domino user ID to an administrator, who certifies and then returns it; the user then merges the updated safe copy back into the user ID.
Displays the User ID dialog box, where the user can define and send encryption keys. If the user's ID is password-protected, the user will be required to enter the password before being allowed access to the dialog box.
Displays the Mail Public Key dialog box. This lets the user send the public key to another user (typically to an administrator who can then paste the public key into that user's Person record in the Domino® Directory).
\ No newline at end of file
diff --git a/javadoc/module-math-trig.html b/javadoc/module-math-trig.html
new file mode 100644
index 00000000..bdde9549
--- /dev/null
+++ b/javadoc/module-math-trig.html
@@ -0,0 +1,5 @@
+Module: math-trig
Returns the absolute (unsigned) value of one or more number(s).
Category: Math and trigonometry
Parameters:
Name
Type
Attributes
Description
value
number
<repeatable>
Number or number list. The numbers whose absolute value is to be calculated. Any number whether positive or negative, whole or fractional, integer or real.
Number or number list. The trigonometric arccosine of value. An angle, in radians, from 0 through pi. This represents an angle between 0 and 180 degrees.
A number 1 to 19 that specifies which function to use.
options
number
A numerical value that determines which values to ignore in the evaluation range for the function. Note: The function will not ignore hidden rows, nested subtotals or nested aggregates if the array argument includes a calculation, for example: =AGGREGATE(14,3,A1:A100*(A1:A100>0),1)
ref1
number |Array.<number>
The first numeric argument for functions that take multiple numeric arguments for which you want the aggregate value.
ref2
number
<optional>
Optional. Numeric arguments 2 to 253 for which you want the aggregate value. For functions that take an array, ref1 is an array, an array formula, or a reference to a range of values for which you want the aggregate value. Ref2 is a second argument that is required for certain functions.
Number or number list. The trigonometric arcsine of value. An angle, in radians, from -pi/2 through pi/2. This represents an angle between -90 and 90 degrees.
Number or number list. The trigonometric arctan of value. An angle, in radians, from -pi/2 through pi/2. This represents an angle between -90 and 90 degrees.
Number or number list. The trigonometric arctangent of y / x. An angle, in radians, from -pi through pi. This represents an angle between -180 and 180 degrees, depending on the sign of x and y.
Number of combinations (with repititions) for the given number of items.
Type:
number
Example
rosetta.combina(3, 2) // returns 6
(inner) cos(…angle) → {number}
Given an angle in radians, returns the cosine of the angle. In a right triangle, the cosine of an acute angle is the ratio of the length of its adjacent side to the length of the hypotenuse.
Category: Math and trigonometry
Parameters:
Name
Type
Attributes
Description
angle
number
<repeatable>
Number or number list. An angle measured in radians for which you want the cosine.
Returns 1 (true) if the difference of the numbers is less than the confidence range. Returns 0 (false) if the difference of the numbers exceeds or is equal to the confidence range.
The number rounded down to the nearest multiple given.
Type:
number
Example
rosetta.floor(3.7, 2) // returns 2
(inner) gcd(…numbers) → {number}
Returns the greatest common divisor.
Category: Math and trigonometry
Parameters:
Name
Type
Attributes
Description
numbers
number
<repeatable>
Number or number list. One is required, subsequent numbers are optional. 1 to 255 values for which you want the greatest common divisor. If any value is not an integer, it is truncated.
Number or number list. One is required, subsequent numbers are optional. 1 to 255 values for which you want the least common multiple. If value is not an integer, it is truncated.
Number or number list. The larger of the values provided. If the parameters are number lists, NotesFormula Max returns a list that is the result of pair-wise computation on the list values and OpenFormula Max concats the lists and returns the number result.
Type:
number
Examples
rosetta.max(4,5,6); // returns 6
rosetta.max([5,8,6,7],[2,9,3]); // returns [5, 9, 6, 7] or 9
(inner) min(…values) → {number}
Returns the smallest number in a single list, or the smaller of two numbers or number lists.
Number or number list. NotesFormula Max returns a list that is the result of pair-wise computation on the list values and OpenFormula Max concats the lists and returns the number result.
Type:
number
Examples
rosetta.min(4,5,6); // returns 4
rosetta.min([5,8,6,7],[2,9,3]); // returns [2, 8, 3, 7] or 2
(inner) minus(num1, num2) → {number}
Returns the difference between the two given numbers.
Number that is the remainder of dividend divided by divisor. If the parameters are number lists, mod returns a list that is the result of pair-wise computation on the list values.
Type:
number
Example
rosetta.mod(7,4); // returns 3
(inner) modulo(dividend, divisor) → {number}
Returns the remainder of a division operation.
Category: Math and trigonometry
Parameters:
Name
Type
Description
dividend
number
Number or number list. The dividend (numerator) to be divided.
divisor
number
Number or number list. The divisor (denominator) to be divide dividend by.
Number or number list. The remainder of dividend divided by divisor. If the parameters are number lists, mod returns a list that is the result of pair-wise computation on the list values.
Type:
number
Examples
rosetta.modulo(7,4); // returns 3
rosetta.modulo([7,5],[4,3]); // returns [3,2]);
(inner) mRound(number, multiple) → {number}
Returns a number rounded to the desired multiple.
Category: Math and trigonometry
Parameters:
Name
Type
Description
number
number
Number that is the value to round.
multiple
number
Number that is the multiple to which you want to round the number.
Number or number list. The value of number, rounded to the specified factor or to the nearest whole number. If number is a list, each number in the list is rounded to the specified factor or to the nearest whole number.
Returns the sum of a power series based on the formula.
Category: Math and trigonometry
Parameters:
Name
Type
Description
x
number
The input value to the power series.
power
number
The initial power to which you want to raise x.
step
number
The step by which to increase n for each term in the series.
coefficients
Array.<number>
A set of coefficients by which each successive power of x is multiplied. The number of values in coefficients determines the number of terms in the power series. For example, if there are three values in coefficients, then there will be three terms in the power series.
Number or number list. May be any of the following values: signed number is negative, - 1, signed number is zero, 0, signed number is positive, 1
Type:
number
Examples
rosetta.sign(5); // returns 1
rosetta.sign(5,-6,7); // returns [1, -1, 1]
(inner) sin(…angle) → {number}
Given an angle in radians, returns the sine of the angle. In a right triangle, the sine of an acute angle is the ratio of the length of its opposite side to the length of the hypotenuse.
Category: Math and trigonometry
Parameters:
Name
Type
Attributes
Description
angle
number
<repeatable>
Number or number list. An angle expressed in radians for which you want the sine.
Number 1-11 or 101-111 that specifies the function to use for the subtotal. 1-11 includes manually-hidden rows, while 101-111 excludes them; filtered-out values are always excluded.
ref1
Array.<number>
Number or number list. The first named range or reference for which you want the subtotal.
The range of values that you want evaluated by criteria. Cells in each range must be numbers or names, arrays, or references that contain numbers. Blank and text values are ignored.
criteria
*
The criteria in the form of a number, expression, a value reference, text, or a function that defines which values will be added.
sum_range
Array.<number>
<optional>
Optional. The actual values to add, if you want to add values other than those specified in the range argument. If the sum_range argument is omitted, Excel adds the values that are specified in the range argument (the same values to which the criteria is applied). Sum_range should be the same size and shape as range. If it isn't, performance may suffer, and the formula will sum a range of values that starts with the first value in sum_range but has the same dimensions as range.
Number or number list. One number is required, subsequent numbers are optional. 1 to 255 arguments for which you want the sum of the squares. You can also use a single array or a reference to an array instead of arguments separated by commas.
Given an angle in radians, returns the tangent of the angle. In a right triangle the tangent of an acute angle is the ratio of the length of the opposite side to the length of the adjacent side.
Category: Math and trigonometry
Parameters:
Name
Type
Attributes
Description
angle
number
<repeatable>
Number or number list. An angle expressed in radians for which you want the tangent.
\ No newline at end of file
diff --git a/javadoc/module-messaging.html b/javadoc/module-messaging.html
new file mode 100644
index 00000000..69309894
--- /dev/null
+++ b/javadoc/module-messaging.html
@@ -0,0 +1,3 @@
+Module: messaging
\ No newline at end of file
diff --git a/javadoc/module-miscellaneous.html b/javadoc/module-miscellaneous.html
new file mode 100644
index 00000000..8b12fb51
--- /dev/null
+++ b/javadoc/module-miscellaneous.html
@@ -0,0 +1,3 @@
+Module: miscellaneous
Puts Designer into debug mode, so that all LotusScript® scripts run in the debugger. The command is a toggle; selecting it again takes Notes® out of debug mode.
Brings up a dialog box that displays the current document (either open or selected in a view). The dialog box shares fields with the underlying document. The user interacts with the dialog box as usual, clicking OK or Cancel when finished.
This function can be used with any form, but it's particularly useful with forms that contain a single table or layout region, because the user can interact with the table or layout region as if it were a dialog box.
Displays the Directories dialog box which allows you to search for an address, view detailed information about an address entry, and add an entry to your Domino® Directory with the Directories dialog box.
When used with no parameters, @MailSend mails the current document (the one being processed when the @function is evaluated) to the recipient designated in the document's SendTo field. The document must have a SendTo field.
When used with one or more parameters, @MailSend composes a new mail memo based on the information you supply in the arguments list, and sends it to the recipients listed in the sendTo, copyTo, and blindcopyTo arguments.
In Standard Outline views, filters a view to display only documents from a specified category. In Calendar views, filters a view to display only documents that contain a specified string in a specified column.
Cycles through the list of styles that have been defined for the current document, form, or page. This is the same as pressing F11. Each time you invoke StyleCycleKey, a different style goes into effect.
\ No newline at end of file
diff --git a/javadoc/module-navigate.html b/javadoc/module-navigate.html
new file mode 100644
index 00000000..c42d4f5a
--- /dev/null
+++ b/javadoc/module-navigate.html
@@ -0,0 +1,3 @@
+Module: navigate
Opens a navigator in Testing mode, so you can test its hotspots, formulas, and scripts. Selecting this command again puts the navigator back into Design mode.
\ No newline at end of file
diff --git a/javadoc/module-network.html b/javadoc/module-network.html
new file mode 100644
index 00000000..820d337a
--- /dev/null
+++ b/javadoc/module-network.html
@@ -0,0 +1,3 @@
+Module: network
\ No newline at end of file
diff --git a/javadoc/module-object.html b/javadoc/module-object.html
new file mode 100644
index 00000000..4a8b8544
--- /dev/null
+++ b/javadoc/module-object.html
@@ -0,0 +1,3 @@
+Module: object
\ No newline at end of file
diff --git a/javadoc/module-open.html b/javadoc/module-open.html
new file mode 100644
index 00000000..844a8da5
--- /dev/null
+++ b/javadoc/module-open.html
@@ -0,0 +1,3 @@
+Module: open
Opens a frameset defined for the current database. Framesets provide a way for designers to display several pages at the same time. A frame is actually one page; a frameset is a collection of pages. Page designers can create links between frames. A major advantage of framesets is the ability to leave one page constant as users scroll or link to other pages.
Allows you to create your own context-sensitive help documents. To use this command, you must first create a view that has a sorted first column containing key values that uniquely identify each help document. @Command([OpenHelpDocument]) searches this sorted view for the specified key value and, if found, displays the associated help document in a separate Help window.
Opens a page defined for the current database. A page is a design element that structures and displays information, including text, graphics, applets, and links. Unlike a form, a page cannot contain fields, subforms, layout regions, and some embedded controls.
\ No newline at end of file
diff --git a/javadoc/module-refresh.html b/javadoc/module-refresh.html
new file mode 100644
index 00000000..022a70f8
--- /dev/null
+++ b/javadoc/module-refresh.html
@@ -0,0 +1,3 @@
+Module: refresh
This formula sends the values entered in the dialog box to the parent document. A designer can update a parent note and close the dialog box without having to use the OK button on the dialog box.
\ No newline at end of file
diff --git a/javadoc/module-replicator.html b/javadoc/module-replicator.html
new file mode 100644
index 00000000..6b7c14cb
--- /dev/null
+++ b/javadoc/module-replicator.html
@@ -0,0 +1,3 @@
+Module: replicator
\ No newline at end of file
diff --git a/javadoc/module-rosetta-api-context.html b/javadoc/module-rosetta-api-context.html
new file mode 100644
index 00000000..3e6ea9eb
--- /dev/null
+++ b/javadoc/module-rosetta-api-context.html
@@ -0,0 +1,3 @@
+Module: rosetta-api-context
\ No newline at end of file
diff --git a/javadoc/module-rosetta-api-voltmx-rosettaServicesEntry.html b/javadoc/module-rosetta-api-voltmx-rosettaServicesEntry.html
new file mode 100644
index 00000000..bae8dee3
--- /dev/null
+++ b/javadoc/module-rosetta-api-voltmx-rosettaServicesEntry.html
@@ -0,0 +1,3 @@
+Class: rosettaServicesEntry
\ No newline at end of file
diff --git a/javadoc/module-rosetta-api-voltmx-rosettaVMXObject.html b/javadoc/module-rosetta-api-voltmx-rosettaVMXObject.html
new file mode 100644
index 00000000..f7ab6354
--- /dev/null
+++ b/javadoc/module-rosetta-api-voltmx-rosettaVMXObject.html
@@ -0,0 +1,3 @@
+Class: rosettaVMXObject
\ No newline at end of file
diff --git a/javadoc/module-rosetta-api-voltmx.html b/javadoc/module-rosetta-api-voltmx.html
new file mode 100644
index 00000000..ebd817aa
--- /dev/null
+++ b/javadoc/module-rosetta-api-voltmx.html
@@ -0,0 +1,3 @@
+Module: rosetta-api-voltmx
\ No newline at end of file
diff --git a/javadoc/module-rosetta-api.html b/javadoc/module-rosetta-api.html
new file mode 100644
index 00000000..be5050f5
--- /dev/null
+++ b/javadoc/module-rosetta-api.html
@@ -0,0 +1,111 @@
+Module: rosetta-api
The names of the tern file definitions generated for the Rossetta API. Keys are "API" for the Rosetta javascript API, "Notes" for the Notes formula, and "OpenFormula" for OpenFormula.
True if the default API is set to Open Formula false otherwise
Type:
boolean
(inner) registerAPI(apiRef, data) → {Object}
Register an API by adding it as an object to the referential array of APIs Defines/redefines the Rosetta API library by creating/updating a node in the API object The API object may be redefined if when using the existing category, name, language combination If language param is supplied, the API node will also define the method at the formula language level and the main method will point to call the method inside the language object
Parameters:
Name
Type
Description
apiRef
Object
required. reference to the rosetta API object tree where to register the method.
data
Object
required. object defining the extended API. object props as follows: "name" :required. the API method name to register under rosetta "cat" :optional. the category name where the API name will be defined under. default: "Custom" "lang" :optional. the formula language implementation layer to register the method under. default: undefined "namef":optional. the method name to use in the formula lang implementations layer. default: name arg "code" : <String|Function> optional. a string with the formula to convert or a callback function. default: noop: () => {}
\ No newline at end of file
diff --git a/javadoc/module-section.html b/javadoc/module-section.html
new file mode 100644
index 00000000..6ad129c3
--- /dev/null
+++ b/javadoc/module-section.html
@@ -0,0 +1,3 @@
+Module: section
\ No newline at end of file
diff --git a/javadoc/module-showhide.html b/javadoc/module-showhide.html
new file mode 100644
index 00000000..dd64f179
--- /dev/null
+++ b/javadoc/module-showhide.html
@@ -0,0 +1,3 @@
+Module: showhide
\ No newline at end of file
diff --git a/javadoc/module-statistical.html b/javadoc/module-statistical.html
new file mode 100644
index 00000000..9a3b2230
--- /dev/null
+++ b/javadoc/module-statistical.html
@@ -0,0 +1,3 @@
+Module: statistical
Returns the average of the absolute deviations of data points from their mean.
Category: Statistical
Parameters:
Name
Type
Description
args
number
number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want the average of the absolute deviations. You can also use a single array or a reference to an array instead of arguments separated by commas.
number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate the sum of squared deviations. You can also use a single array or a reference to an array instead of arguments separated by commas.
Returns a frequency distribution as a vertical array.
Category: Statistical
Parameters:
Name
Type
Description
data_array
number
An array of or reference to a set of values for which you want to count frequencies. If data_array contains no values, FREQUENCY returns an array of zeros.
bins_array
number
An array of or reference to intervals into which you want to group the values in data_array. If bins_array contains no values, FREQUENCY returns the number of elements in data_array.
0.5 less than the standard normal cumulative districubtion or an error if the arguments are incorrect.
Type:
number
(inner) geoMean(args) → {number}
Returns the geometric mean.
Category: Statistical
Parameters:
Name
Type
Description
args
number
number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate the mean. You can also use a single array or a reference to an array instead of arguments separated by commas.
The set of y-values you already know in the relationship y = b*m^x.
If the array known_y's is in a single column, then each column of known_x's is interpreted as a separate variable.
If the array known_y's is in a single row, then each row of known_x's is interpreted as a separate variable.
If any of the numbers in known_y's is 0 or negative, GROWTH returns the #NUM! error value.
known_x
number
Optional. An optional set of x-values that you may already know in the relationship y = b*m^x.
The array known_x's can include one or more sets of variables. If only one variable is used, known_y's and known_x's can be ranges of any shape, as long as they have equal dimensions. If more than one variable is used, known_y's must be a vector (that is, a range with a height of one row or a width of one column).
If known_x's is omitted, it is assumed to be the array {1,2,3,...} that is the same size as known_y's.
new_x
number
Optional. Are new x-values for which you want GROWTH to return corresponding y-values.
new_x's must include a column (or row) for each independent variable, just as known_x's does. So, if known_y's is in a single column, known_x's and new_x's must have the same number of columns. If known_y's is in a single row, known_x's and new_x's must have the same number of rows.
If new_x's is omitted, it is assumed to be the same as known_x's.
If both known_x's and new_x's are omitted, they are assumed to be the array {1,2,3,...} that is the same size as known_y's.
use_const
boolean
Optional. A logical value specifying whether to force the constant b to equal 1. If const is TRUE or omitted, b is calculated normally. If const is FALSE, b is set equal to 1 and the m-values are adjusted so that y = m^x.
If const is TRUE or omitted, b is calculated normally.
If const is FALSE, b is set equal to 1 and the m-values are adjusted so that y = m^x.
values along an exponential trend or an error if the arguments are incorrect.
Type:
number
(inner) harMean(args) → {number}
Returns the harmonic mean.
Category: Statistical
Parameters:
Name
Type
Description
args
number
number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate the mean. You can also use a single array or a reference to an array instead of arguments separated by commas.
number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate kurtosis. You can also use a single array or a reference to an array instead of arguments separated by commas.
the k-th largest value in a data set or an error if the arguments are incorrect.
(inner) linest(known_y, known_x) → {number}
Returns the parameters of a linear trend.
Category: Statistical
Parameters:
Name
Type
Description
known_y
number
The set of y-values that you already know in the relationship y = mx + b.
If the range of known_y's is in a single column, each column of known_x's is interpreted as a separate variable.
If the range of known_y's is contained in a single row, each row of known_x's is interpreted as a separate variable.
known_x
number
Optional. A set of x-values that you may already know in the relationship y = mx + b.
The range of known_x's can include one or more sets of variables. If only one variable is used, known_y's and known_x's can be ranges of any shape, as long as they have equal dimensions. If more than one variable is used, known_y's must be a vector (that is, a range with a height of one row or a width of one column).
If known_x's is omitted, it is assumed to be the array {1,2,3,...} that is the same size as known_y's.
the parameters of a linear trend or an error if the arguments are incorrect.
Type:
number
(inner) logest(known_y, known_x)
Returns the parameters of an exponential trend.
Category: Statistical
Parameters:
Name
Type
Description
known_y
number
The set of y-values you already know in the relationship y = b*m^x.
If the array known_y's is in a single column, then each column of known_x's is interpreted as a separate variable.
If the array known_y's is in a single row, then each row of known_x's is interpreted as a separate variable.
known_x
number
Optional. An optional set of x-values that you may already know in the relationship y = b*m^x.
The array known_x's can include one or more sets of variables. If only one variable is used, known_y's and known_x's can be ranges of any shape, as long as they have equal dimensions. If more than one variable is used, known_y's must be a range of values with a height of one row or a width of one column (which is also known as a vector).
If known_x's is omitted, it is assumed to be the array {1,2,3,...} that is the same size as known_y's.
the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects or an error if the arguments are incorrect.
Type:
number
(inner) phi(x) → {number}
Returns the value of the density function for a standard normal distribution.
Category: Statistical
Parameters:
Name
Type
Description
x
number
X is the number for which you want the density of the standard normal distribution.
the square of the Pearson product moment correlation coefficient or an error if the arguments are inforrect.
Type:
number
(inner) skew(args) → {number}
Returns the skewness of a distribution.
Category: Statistical
Parameters:
Name
Type
Description
args
Array.<number>
number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate skewness. You can also use a single array or a reference to an array instead of arguments separated by commas.
a normalized value or an error if the arguments are incorrect.
Type:
number
(inner) stDevA(…args) → {number}
Estimates standard deviation based on a sample, including numbers, text, and logical values.
Category: Statistical
Parameters:
Name
Type
Attributes
Description
args
Array.<number>
<repeatable>
value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 values corresponding to a sample of a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
Estimated standard deviation based on a sample, including numbers, text, and logical values or an error.
Type:
number
(inner) stDevPA(…args) → {number}
Calculates standard deviation based on the entire population, including numbers, text, and logical values.
Category: Statistical
Parameters:
Name
Type
Attributes
Description
args
Array.<number>
<repeatable>
value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 values corresponding to a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
values along a linear trend or an error if the arguments are incorrect.
Type:
Array.<number>
(inner) trimMean(range, percent) → {number}
Returns the mean of the interior of a data set.
Category: Statistical
Parameters:
Name
Type
Description
range
Array.<number>
The array or range of values to trim and average.
percent
number
The fractional number of data points to exclude from the calculation. For example, if percent = 0.2, 4 points are trimmed from a data set of 20 points (20 x 0.2): 2 from the top and 2 from the bottom of the set.
\ No newline at end of file
diff --git a/javadoc/module-text.html b/javadoc/module-text.html
new file mode 100644
index 00000000..ed517f1c
--- /dev/null
+++ b/javadoc/module-text.html
@@ -0,0 +1,3 @@
+Module: text
Converts an LMBCS (Lotus® Multi-Byte Character Set) string to an ASCII string.
Parameters:
Name
Type
Description
Text
String
or text list. An LMBCS string.
Boolean.
Boolean
Optional. Specifies that Ascii should return a null string ("") if any characters in the original string cannot be represented by ASCII codes 32 to 127.
Text or text list. The original string, with each character converted to an ASCII-compliant character. Any character that can't be represented by ASCII codes 32 to 127 is replaced with a question mark (?). If you specify [ALLINRANGE] and there are characters that can't be represented by ASCII codes 32 to 127, returns a null string ("").
(true) if substring is contained within string, beginning from the first letter. Returns 0 (false) if not. This function is case-sensitive. If the either parameter is a list, the function tests each element of the second parameter against each element of the first parameter and returns 1 if any match occurs.
true (1) if any substring is contained in one of the strings. Returns false (0) if no substrings are contained in any of the strings. Note: If any element in the substrings is a null string(""), this function always returns true. This function is case-sensitive. If either parameter is a list, the function returns 1 if any element of parameter 1 contains any element of parameter 2.
(true) if substring is contained within string, beginning from the first letter. Returns 0 (false) if not. This function is case-sensitive. If the either parameter is a list, the function tests each element of the second parameter against each element of the first parameter and returns 1 if any match occurs.
Searches a string from left to right and returns the leftmost characters of the string.
Parameters:
Name
Type
Description
text
string
or text list. The string where you want to find the leftmost characters.
param
number |string
Number: The number of characters to return. If the number is 2, the first two characters of the string are returned; if the number is 5, the first five characters are returned, and so on. If the number is negative, the entire string is returned. If using Open Formula implementation, param must be a number and is optional with a default of 1.
String: A substring of stringToSearch. Left returns the characters to the left of subString. It finds subString by searching stringToSearch from left to right. A string is only valid for the Notes formula implementation and param is required.
The leftmost characters in stringToSearch. The number of characters returned is determined by either numberOfChars or subString. Left returns "" if subString is not found in stringToSearch.
Searches a string from right to left and returns a substring.
Parameters:
Name
Type
Description
stringToSearch
string |Array.<string>
The string where you want to find the leftmost characters.
param
number
Counting from right to left, the number of characters to skip. All the characters to the left of that number of characters are returned. If the number is negative, the entire string is returned.
If the parameter is a text string, length returns the number of characters in the specified string, including spaces and punctuation. If the argument is a text list, length searches the list of strings and returns the number of characters in each string as a number list.
Tests a string for a pattern string. Because the pattern string can contain a number of "wildcard" characters and logical symbols, you can test for complex character patterns.
Returns any substring from the middle of a string. The middle is found by scanning the string from left to right, and parameters determine where the middle begins and ends.
Parameters:
Name
Type
Description
Text
String
or text list. Any string.
Number.
Number
A character position in string that indicates where you want the middle to begin, always counting from left to right. The middle begins one character after the offset.
Text.
String
A substring of string that indicates where you want the middle to begin, always counting from left to right. The middle begins one character after the end of startString.
Number.
Number
The number of characters that you want in the middle. If numberchars is negative, the middle starts at offset or startString and continues from right to left. If numberchars is positive, the middle starts one character past the offset or startString and continues from left to right.
Text.
String
A substring of string that indicates the end of the middle. Middle returns all the characters between offset and endstring, or between startString and endstring.
Text or text list. The substring from the middle of string, which begins at the offset or startString you specify and ends at the endstring you specify, or after the numberchars have been reached.
rosettajs.middle('This is the text', 4, 'text); // returns ' is the '
rosettajs.middle(["Hello world", "This is the time"], 0, " "); // returns ['Hello', 'This']
(inner) middleBack(Text) → {String}
Returns any substring from the middle of a string. The middle is found by scanning the string from right to left, and parameters determine where the middle begins and ends.
Parameters:
Name
Type
Description
Text
String
or text list. Any string.
Number.
Number
A character position in string that indicates where you want the middle to begin, always counting from right to left. The middle begins one character after the offset. Always add 1 to this number; the end of the string is marked by one non-visible character and must be counted in the offset.
Text.
String
A substring of string that indicates where you want the middle to begin, always counting from right to left. The middle begins one character after the end of startString.
Number.
Number
The number of characters that you want in the middle. If numberchars is negative, the middle starts at offset or startString and continues from right to left. If numberchars is positive, the middle starts one character past the offset or startString and continues from left to right.
Text.
String
A substring of string that indicates the end of the middle. MiddleBack returns all the characters between offset and endstring, or between startString and endstring.
Text or text list. The substring from the middle of string, which begins at the offset or startString you specify and ends at the endstring you specify, or after the numberchars have been reached.
rosettajs.middleBack('This is the text', 'text', 'is'); // returns ' the '
rosettajs.middleBack(["Hello world", "This is the time"], 0, " "); // returns ["world", "time"]
(inner) narrow(Text) → {String}
Converts full-pitch alphanumeric characters (double byte characters -- DBCS) in the specified string to half-pitch alphanumeric characters (single byte characters -- SBCS). This function works in Japanese, Korean, Simplified Chinese, and traditional Chinese environments. In the Japanese environment, this function can convert full-pitch Katakana as well.
Parameters:
Name
Type
Description
Text
String
or text list. The string that you want to convert to single byte characters.
Text or text list. The sourceList, with any values from fromList replaced by the corresponding value in toList. If none of the values in fromList matched the values in sourceList, then sourceList is returned unaltered.
Type:
String
Examples
rosettajs.replaceSubstring("I like apples", "like", "hate"); // returns 'I hate apples'
rosettajs.replaceSubstring("I like apples", ["like", "apples"], ["hate", "peaches"]); // returns 'I hate peaches'
rosettajs.replaceSubstring(["I like apples", "I like bananas"], ["like", "I"], ["hates", "He"]); // returns ["He hates apples", "He hates bananas"]
(inner) right(param) → {String}
Returns the rightmost characters in the string. You can specify the number of rightmost characters you want returned, or you can indicate that you want all the characters following a specific substring.
Parameters:
Name
Type
Description
param
number |string
Number: The number of characters to return. If the number is 2, the first two characters of the string are returned; if the number is 5, the first five characters are returned, and so on. If the number is negative, the entire string is returned. If using Open Formula implementation, param must be a number and is optional with a default of 1.
String: A substring of stringToSearch. Left returns the characters to the left of subString. It finds subString by searching stringToSearch from left to right. A string is only valid for the Notes formula implementation and param is required.
Text or text list. The rightmost characters in stringToSearch. The number of characters returned is determined by either numberOfChars or subString. Right returns "" if subString is not found in stringToSearch.
or text list. The string whose rightmost characters you want to find.
Number.
Number
Counting from left to right, the number of characters to skip. All the characters following that number are returned.
Text.
String
A substring of stringToSearch. @RightBack returns all the characters following subString. It finds subString by searching stringToSearch from right to left.
Converts a text string to a number, where possible.
Parameters:
Name
Type
Description
...args
Array
Text or text list. The string you want to convert to a number. If the string contains both numbers and letters, it must begin with a number to be converted properly. For example, the string "12ABC" converts to 12, but "ABC12" produces an error.
Converts a canonical time zone value to a human-readable text string.
Parameters:
Name
Type
Description
Canonical
String
time zone value or list thereof. Use a Notes® Time zone field to create a time zone value.
Optional.
String
String consisting of one or more of the following format specifiers: S = Short time zone string, A = Alias for local time zone. For example, if the zone is the same as the zone in which the system is running, returns: "Local time".
Converts half-pitch alphanumeric characters (single-byte characters -- SBCS) in the specified string to full-pitch alphanumeric characters (double-byte characters -- DBCS). This function works in Japanese, Korean, Simplified Chinese, and traditional Chinese environments. In the Japanese environment, this function can convert half-pitch Katakana as well.
Parameters:
Name
Type
Description
Text
String
or text list. The string you want to convert to double-byte characters.
Returns the specified word from a text string. A "word" is defined as the part of a string that is delimited by the defined separator character. For example, if you specify a space (" ") as the separator, then a word is any series of characters preceded by and followed by a space (or the beginning or end of the string).
\ No newline at end of file
diff --git a/javadoc/module-tools.html b/javadoc/module-tools.html
new file mode 100644
index 00000000..b79c5fd6
--- /dev/null
+++ b/javadoc/module-tools.html
@@ -0,0 +1,3 @@
+Module: tools
Displays the Replicate dialog box, where the user can choose to replicate the current database using the options defined in Replicator or using special one-time options.
Runs all of the database's scheduled agents, regardless of when they are scheduled to run. The agents will then run as usual at their regularly scheduled times.
Opens the current location document in your Personal Address Book in Edit mode, allowing you to change your home server, mail database location, and time zone.
Displays the Mail section of the User Preferences dialog box, where the user can indicate how often Notes® should check for new mail, whether to sign and encrypt outgoing mail, and so on.
\ No newline at end of file
diff --git a/javadoc/module-user-environment.html b/javadoc/module-user-environment.html
new file mode 100644
index 00000000..17dc8a70
--- /dev/null
+++ b/javadoc/module-user-environment.html
@@ -0,0 +1,3 @@
+Module: user-environment
Allows you to manipulate hierarchical names. You can abbreviate the canonical format of a name, expand an abbreviated name to its canonical format, identify particular components within the name, and reverse the order of the components so that you can categorize a view by hierarchical names.
Enables you to convert a name between the Domino® and LDAP formats.
If the user name is hierarchical, @UserName returns it in canonical format (including the CN, OU, O, and C identifiers). To return the name in abbreviated format (omitting those identifiers), use @V3UserName.
For a database on a server or a local database with "Enforce a consistent Access Control List across all replicas" in effect, @UserNamesList returns a text list containing the following information for the current user:
Common name
All hierarchical names (fully distinguished) that include the user name; for example, CN=My Name/OU=My Org Unit/O=My Org, plus */OU=My Org Unit/O=My Org, */O=My Org, and *
Any roles associated with the user in the ACL
All groups to which the user belongs (only if the database is on a server)
Returns a text list of the current user's privileges. This function returns only the position of the privilege in the privilege list, not the name of the privilege.
For a database on a server or a local replicated database, returns a list of roles that the current user has. Roles are defined in a database's access control list.
Returns the current user name or server name. Using @V3UserName on a local database or in a private view in a server-based database returns the user's name.
If the user name is hierarchical, @V3UserName returns the name in abbreviated format (omitting the CN, OU, O, and C identifiers). To return the name in canonical format, use @UserName.
\ No newline at end of file
diff --git a/javadoc/module-userid.html b/javadoc/module-userid.html
new file mode 100644
index 00000000..859e225a
--- /dev/null
+++ b/javadoc/module-userid.html
@@ -0,0 +1,3 @@
+Module: userid
Displays the Certificates section of the User ID dialog box. If the user ID is password-protected, the user must enter the password before displaying the dialog box.
Displays the Enter Safe Copy ID File Name dialog box, where the user defines a file name for storing a safe copy of the Notes/Domino user ID. The safe copy contains only the user name and public key. The private key and all certificates are omitted from the safe copy.
Displays the Encryption section of the User ID dialog box. If the user ID is password-protected, the user must enter the password before displaying the dialog box.
Displays the Choose User ID to Merge into Current® ID dialog box. This lets the user select an updated user ID (for example, one that has been certified by an administrator) and merge it into the existing user ID (thus retaining the information already stored in the existing ID). If the user ID is password-protected, Notes/Domino requires the user to enter the password before displaying the dialog box.
Displays the Set Password dialog box where the user can enter a new password for the Notes/Domino ID. If a password already exists, the user must enter the existing password before specifying a new one.
Displays the Choose User ID to Switch To dialog box. If the selected ID is password-protected, Notes/Domino next displays the Enter Password dialog box, where the user must enter the correct password.
\ No newline at end of file
diff --git a/javadoc/module-view.html b/javadoc/module-view.html
new file mode 100644
index 00000000..4ab7b2a5
--- /dev/null
+++ b/javadoc/module-view.html
@@ -0,0 +1,3 @@
+Module: view
Switches to the specified view or folder within the current database or, if a view or folder is not specified, displays the View menu so the user can select a view.
Collapses all levels of subcategories, documents, and responses within the current category, so only the first category name shows. If the view or folder has a response hierarchy but is not categorized, ViewCollapse collapses all levels of response documents under the current main document.
Collapses all levels of categories, subcategories, documents, and responses within a view or folder so that only the first level of category names appears. If the view or folder has a response hierarchy but is not categorized, ViewCollapseAll collapses all levels of response documents under the main documents.
Expands one level of subcategories, documents, and responses within the current category. If the view or folder has a response hierarchy but is not categorized, ViewExpand expands all levels of response documents under the current main document.
Displays the Certify Selected Entries dialog box, which enables you to upgrade the selected user name to a hierarchical name, change the user's common name, or change the user's hierarchical name.
Shows field Help, so that the Help description for the current field (if available) appears on the status bar while the user composes or edits a document. (Field Help is a design option specified in the Field Properties box.) This command is a toggle; selecting it a second time hides the field Help.
Displays the "object delimiter" -- a dotted frame surrounding an OLE/LEL object within a field. This command is a toggle; selecting it a second time hides the object delimiter so the OLE/LEL object looks like regular, editable data.
Collapses the view or folder so that only category and subcategory names show up. This command is a toggle; selecting it a second time expands all category levels.
Shows the results of a full-text search as selected documents in a view or folder. This command is a toggle. Instead of listing only the documents that satisfy the search query (the default for a full-text search), the view or folder lists all the documents it normally lists, with a check mark in front of those documents that satisfy the search query.
Displays only the selected documents or categories in the view or folder (those documents with a check mark). This command is a toggle; selecting it a second time displays all documents or categories.
Displays a line representing each page break in the document. The page breaks indicate where Notes® will end each page when the document is printed on the currently selected printer. This command is a toggle; selecting it a second time suppresses the display of automatic page breaks (manual page breaks will still be displayed).
Toggles the display of the full-text search bar at the beginning of the view. If the database does not have a full-text index, the search bar displays but is not usable.
\ No newline at end of file
diff --git a/javadoc/module-volt-formula.html b/javadoc/module-volt-formula.html
new file mode 100644
index 00000000..05914423
--- /dev/null
+++ b/javadoc/module-volt-formula.html
@@ -0,0 +1,3 @@
+Module: volt-formula
Gets the current API context (if ctx param is null or not supplied) or Sets the API context to either database for local DOM, for those APIs that require working with differents contexts such as GetField/SetField
Uses the console object's methods to display Debug messages, prepending them with a timestamp. Defaults to console.log() if no type of logger is supplied
Parameters:
Name
Type
Description
msg
string
message
type
string
logger to employ: 'Error', 'Warning', 'Info', 'Debug', 'Log' from the console object, or javascript alert if type is Alert
\ No newline at end of file
diff --git a/javadoc/module-window.html b/javadoc/module-window.html
new file mode 100644
index 00000000..69413838
--- /dev/null
+++ b/javadoc/module-window.html
@@ -0,0 +1,3 @@
+Module: window
Same as the File - Close command menu. Closes the current Notes® tab, or the window if this was the last tab in the window. If the document or design element in that window has not been saved, Notes® prompts the user to save it before closing.
Resizes all open Notes/Domino windows to less than 50% of their maximum window size and layers them in a cascading stack. Because the layered stack is cascaded, the title bar of each window is visible behind the stack's first window. To display a window that is lower in the stack, you can make it first by clicking its title bar.
Maximizes all open Notes/Domino windows. Notes/Domino windows include the Designer and Administration client windows as well as any of the Notes® Help windows.
Minimizes all open Notes/Domino windows. Notes/Domino windows include the Designer and Administration client windows as well as any of the Notes® Help windows.
Maximizes the Notes® window whose taskbar button follows the current window's taskbar button or, if the windows are cascaded, moves the next window in the stack to the beginning of the stack.
Resizes all open Notes/Domino windows to display them all at once. The open windows are tiled across the screen until they fill the background. If two windows are currently open, Notes® displays them side-by-side. If four windows are open, Notes® displays one in each of the four quadrants of the window.
\ No newline at end of file
diff --git a/javadoc/module-workspace.html b/javadoc/module-workspace.html
new file mode 100644
index 00000000..ab1d8704
--- /dev/null
+++ b/javadoc/module-workspace.html
@@ -0,0 +1,3 @@
+Module: workspace
For databases on the workspace that are replicas of one another, stacks them into a single icon. The command is a toggle; selecting it a second time unstacks the replica icons and displays each icon individually.
\ No newline at end of file
diff --git a/javadoc/navigate.js.html b/javadoc/navigate.js.html
new file mode 100644
index 00000000..f246c3b6
--- /dev/null
+++ b/javadoc/navigate.js.html
@@ -0,0 +1,208 @@
+Source: navigate.js
"use strict";
+/**
+ * @file Navigate
+ * @module navigate
+ * @category Navigate
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navPrevUnread = exports.navPrevSelected = exports.navPrevMain = exports.navPrev = exports.navNextUnread = exports.navNextSelected = exports.navNextMain = exports.navNext = exports.navigatorTest = exports.navigatorProperties = exports.navigateToBacklink = exports.navigatePrevUnread = exports.navigatePrevSelected = exports.navigatePrevMain = exports.navigatePrevHighlight = exports.navigatePrev = exports.navigateNextUnread = exports.navigateNextSelected = exports.navigateNextMain = exports.navigateNextHighlight = exports.navigateNext = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/navigate"));
+exports._notes = notesc;
+//-----------------------------
+// Notes @Commands navigate
+/**
+ * Navigates to the next document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATENEXT.html|www.hcltechsw.com }
+ */
+function navigateNext() {
+ return notesc.NavigateNext();
+}
+exports.navigateNext = navigateNext;
+/**
+ * Navigates to the next full-text search highlight within a document, working from
+ * left to right and beginning to end.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATENEXTHIGHLIGHT.html|www.hcltechsw.com }
+ */
+function navigateNextHighlight() {
+ return notesc.NavigateNextHighlight();
+}
+exports.navigateNextHighlight = navigateNextHighlight;
+/**
+ * Navigates to the next main document in the current view.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATENEXTMAIN.html|www.hcltechsw.com }
+ */
+function navigateNextMain() {
+ return notesc.NavigateNextMain();
+}
+exports.navigateNextMain = navigateNextMain;
+/**
+ * Navigates to the next selected document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATENEXTSELECTED.html|www.hcltechsw.com }
+ */
+function navigateNextSelected() {
+ return notesc.NavigateNextSelected();
+}
+exports.navigateNextSelected = navigateNextSelected;
+/**
+ * Navigates to the next unread document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATENEXTUNREAD.html|www.hcltechsw.com }
+ */
+function navigateNextUnread() {
+ return notesc.NavigateNextUnread();
+}
+exports.navigateNextUnread = navigateNextUnread;
+/**
+ * Navigates to the previous document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATEPREV.html|www.hcltechsw.com }
+ */
+function navigatePrev() {
+ return notesc.NavigatePrev();
+}
+exports.navigatePrev = navigatePrev;
+/**
+ * Navigates to the previous full-text search highlight within a document, working
+ * from right to left and end to beginning.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATEPREVHIGHLIGHT.html|www.hcltechsw.com }
+ */
+function navigatePrevHighlight() {
+ return notesc.NavigatePrevHighlight();
+}
+exports.navigatePrevHighlight = navigatePrevHighlight;
+/**
+ * Navigates to the previous main document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATEPREVMAIN.html|www.hcltechsw.com }
+ */
+function navigatePrevMain() {
+ return notesc.NavigatePrevMain();
+}
+exports.navigatePrevMain = navigatePrevMain;
+/**
+ * Navigates to the previous selected document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATEPREVSELECTED.html|www.hcltechsw.com }
+ */
+function navigatePrevSelected() {
+ return notesc.NavigatePrevSelected();
+}
+exports.navigatePrevSelected = navigatePrevSelected;
+/**
+ * Navigates to the previous unread document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATEPREVUNREAD.html|www.hcltechsw.com }
+ */
+function navigatePrevUnread() {
+ return notesc.NavigatePrevUnread();
+}
+exports.navigatePrevUnread = navigatePrevUnread;
+/**
+ * Returns to the document from which you launched the current document.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATEToBackLink.html|www.hcltechsw.com }
+ */
+function navigateToBacklink() {
+ return notesc.NavigateToBacklink();
+}
+exports.navigateToBacklink = navigateToBacklink;
+/**
+ * Displays the Properties box for a navigator.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATORPROPERTIES.html|www.hcltechsw.com }
+ */
+function navigatorProperties() {
+ return notesc.NavigatorProperties();
+}
+exports.navigatorProperties = navigatorProperties;
+/**
+ * Opens a navigator in Testing mode, so you can test its hotspots, formulas, and
+ * scripts. Selecting this command again puts the navigator back into Design mode.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVIGATORTEST.html|www.hcltechsw.com }
+ */
+function navigatorTest() {
+ return notesc.NavigatorTest();
+}
+exports.navigatorTest = navigatorTest;
+/**
+ * Navigates to the next document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVNEXT_COMMAND.html|www.hcltechsw.com }
+ */
+function navNext() {
+ return notesc.NavNext();
+}
+exports.navNext = navNext;
+/**
+ * Navigates to the next main document in the current view.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVNEXTMAIN_COMMAND.html|www.hcltechsw.com }
+ */
+function navNextMain() {
+ return notesc.NavNextMain();
+}
+exports.navNextMain = navNextMain;
+/**
+ * Navigates to the next selected document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVNEXTSELECTED_COMMAND.html|www.hcltechsw.com }
+ */
+function navNextSelected() {
+ return notesc.NavNextSelected();
+}
+exports.navNextSelected = navNextSelected;
+/**
+ * Navigates to the next unread document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVNEXTUNREAD.html|www.hcltechsw.com }
+ */
+function navNextUnread() {
+ return notesc.NavNextUnread();
+}
+exports.navNextUnread = navNextUnread;
+/**
+ * Navigates to the previous document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link <add https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVPREV_COMMAND.html|www.hcltechsw.com }
+ */
+function navPrev() {
+ return notesc.NavPrev();
+}
+exports.navPrev = navPrev;
+/**
+ * Navigates to the previous main document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVPREVMAIN_COMMAND.html|www.hcltechsw.com }
+ */
+function navPrevMain() {
+ return notesc.NavPrevMain();
+}
+exports.navPrevMain = navPrevMain;
+/**
+ * Navigates to the previous selected document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVPREVSELECTED_COMMAND.html|www.hcltechsw.com }
+ */
+function navPrevSelected() {
+ return notesc.NavPrevSelected();
+}
+exports.navPrevSelected = navPrevSelected;
+/**
+ * Navigates to the previous unread document in the current view or folder.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_NAVPREVUNREAD_COMMAND.html|www.hcltechsw.com }
+ */
+function navPrevUnread() {
+ return notesc.NavPrevUnread();
+}
+exports.navPrevUnread = navPrevUnread;
+//# sourceMappingURL=navigate.js.map
\ No newline at end of file
diff --git a/javadoc/network.js.html b/javadoc/network.js.html
new file mode 100644
index 00000000..39739ad2
--- /dev/null
+++ b/javadoc/network.js.html
@@ -0,0 +1,43 @@
+Source: network.js
\ No newline at end of file
diff --git a/javadoc/object.js.html b/javadoc/object.js.html
new file mode 100644
index 00000000..02fdcd79
--- /dev/null
+++ b/javadoc/object.js.html
@@ -0,0 +1,44 @@
+Source: object.js
\ No newline at end of file
diff --git a/javadoc/open.js.html b/javadoc/open.js.html
new file mode 100644
index 00000000..924f7adf
--- /dev/null
+++ b/javadoc/open.js.html
@@ -0,0 +1,94 @@
+Source: open.js
"use strict";
+/**
+ * @file Open
+ * @module open
+ * @category Open
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openView = exports.openDocument = exports.openPage = exports.openNavigator = exports.openHelpDocument = exports.openFrameset = exports.openCalendar = exports._notes_vmx = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc_base = tslib_1.__importStar(require("../notes/open"));
+const notesc_vmx = tslib_1.__importStar(require("../notes/voltmx/open"));
+const API = tslib_1.__importStar(require("../rosetta/API"));
+const notesc = () => API.isDefaultFrameworkVoltMX() ? notesc_vmx : notesc_base;
+exports._notes = notesc_base;
+exports._notes_vmx = notesc_vmx;
+//-----------------------------
+// Notes @Commands open
+/**
+ * Opens a mail file to the Calendar view.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENCALENDAR.html|www.hcltechsw.com }
+ */
+function openCalendar() {
+ return notesc().OpenCalendar();
+}
+exports.openCalendar = openCalendar;
+/**
+ * Opens a frameset defined for the current database. Framesets provide a way for
+ * designers to display several pages at the same time. A frame is actually one
+ * page; a frameset is a collection of pages. Page designers can create links
+ * between frames. A major advantage of framesets is the ability to leave one page
+ * constant as users scroll or link to other pages.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENFRAMESET_8100.html|www.hcltechsw.com }
+ */
+function openFrameset() {
+ return notesc().OpenFrameset();
+}
+exports.openFrameset = openFrameset;
+/**
+ * Allows you to create your own context-sensitive help documents. To use this
+ * command, you must first create a view that has a sorted first column containing
+ * key values that uniquely identify each help document. @Command([OpenHelpDocument])
+ * searches this sorted view for the specified key value and, if found, displays
+ * the associated help document in a separate Help window.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENHELPDOCUMENT_2585_MEMLIST.html|www.hcltechsw.com }
+ */
+function openHelpDocument() {
+ return notesc().OpenHelpDocument();
+}
+exports.openHelpDocument = openHelpDocument;
+/**
+ * Opens a navigator defined for the selected database.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENNAVIGATOR.html|www.hcltechsw.com }
+ */
+function openNavigator() {
+ return notesc().OpenNavigator();
+}
+exports.openNavigator = openNavigator;
+/**
+ * Opens a page defined for the current database. A page is a design element that
+ * structures and displays information, including text, graphics, applets, and
+ * links. Unlike a form, a page cannot contain fields, subforms, layout regions,
+ * and some embedded controls.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENPAGE_1766.html|www.hcltechsw.com }
+ */
+function openPage() {
+ return notesc().OpenPage();
+}
+exports.openPage = openPage;
+/**
+ * Opens a document.
+ * @returns {Promise<boolean>}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENDOCUMENT.html|www.hcltechsw.com }
+ */
+function openDocument(writeOrReadOnly, UNID) {
+ return notesc().OpenDocument(writeOrReadOnly, UNID);
+}
+exports.openDocument = openDocument;
+/**
+ * Opens the specified view in the current database.
+ * @returns {Promise<boolean>}
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_OPENVIEW.html|www.hcltechsw.com }
+ */
+function openView() {
+ return notesc().OpenView();
+}
+exports.openView = openView;
+//# sourceMappingURL=open.js.map
\ No newline at end of file
diff --git a/javadoc/refresh.js.html b/javadoc/refresh.js.html
new file mode 100644
index 00000000..09d0a9c2
--- /dev/null
+++ b/javadoc/refresh.js.html
@@ -0,0 +1,45 @@
+Source: refresh.js
"use strict";
+/**
+ * @file Refresh
+ * @module refresh
+ * @category Refresh
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refreshParentNote = exports.refreshHideFormulas = exports.refreshFrame = exports._notes = void 0;
+const tslib_1 = require("tslib");
+const notesc = tslib_1.__importStar(require("../notes/refresh"));
+exports._notes = notesc;
+//-----------------------------
+// Notes @Commands refresh
+/**
+ * Refreshes the specified frame in a frameset.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REFRESHFRAME_COMMAND.html|www.hcltechsw.com }
+ */
+function refreshFrame() {
+ return notesc.RefreshFrame();
+}
+exports.refreshFrame = refreshFrame;
+/**
+ * Refreshes only the hidden formulas in a document or view.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REFRESHHIDEFORMULAS.html|www.hcltechsw.com }
+ */
+function refreshHideFormulas() {
+ return notesc.RefreshHideFormulas();
+}
+exports.refreshHideFormulas = refreshHideFormulas;
+/**
+ * This formula sends the values entered in the dialog box to the parent document.
+ * A designer can update a parent note and close the dialog box without having to
+ * use the OK button on the dialog box.
+ * @throws {Error} no plans to implement
+ * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/12.0.0/basic/H_REFRESHPARENTNOTE_4582_MEMLIST.html|www.hcltechsw.com }
+ */
+function refreshParentNote() {
+ return notesc.RefreshParentNote();
+}
+exports.refreshParentNote = refreshParentNote;
+//# sourceMappingURL=refresh.js.map
\ No newline at end of file
diff --git a/javadoc/replicator.js.html b/javadoc/replicator.js.html
new file mode 100644
index 00000000..94bd6b5d
--- /dev/null
+++ b/javadoc/replicator.js.html
@@ -0,0 +1,99 @@
+Source: replicator.js
+
+ `}return t}function getSearchResult(e,t,n){var t={...{shouldSort:!0,threshold:.4,location:0,distance:100,maxPatternLength:32,minMatchCharLength:1,keys:t}},a=Fuse.createIndex(t.keys,e);const o=new Fuse(e,t,a),r=o.search(n);return 20{o=null,a||t.apply(this,e)},n),a&&!o&&t.apply(this,e)}}let searchData;async function search(e){e=e.target.value;if(resultBox)if(e){if(!searchData){showResultText("Loading...");try{searchData=await fetchAllData()}catch(e){return console.log(e),void showResultText("Failed to load result.")}}e=getSearchResult(searchData,["title","description"],e);e.length?resultBox.innerHTML=buildSearchResult(e):showResultText("No result found! Try some different combination.")}else showResultText("Type anything to view search result");else console.error("Search result container not found")}function onDomContentLoaded(){const e=document.querySelectorAll(".search-button");var t=debounce(search,300);searchCloseButton&&searchCloseButton.addEventListener("click",hideSearch),e&&e.forEach(function(e){e.addEventListener("click",showSearch)}),searchContainer&&searchContainer.addEventListener("click",hideSearch),searchWrapper&&searchWrapper.addEventListener("click",function(e){e.stopPropagation()}),searchInput&&searchInput.addEventListener("keyup",t),window.location.hash===searchHash&&showSearch()}window.addEventListener("DOMContentLoaded",onDomContentLoaded),window.addEventListener("hashchange",function(){window.location.hash===searchHash&&showSearch()});
\ No newline at end of file
diff --git a/javadoc/scripts/third-party/Apache-License-2.0.txt b/javadoc/scripts/third-party/Apache-License-2.0.txt
new file mode 100644
index 00000000..75b52484
--- /dev/null
+++ b/javadoc/scripts/third-party/Apache-License-2.0.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/javadoc/scripts/third-party/fuse.js b/javadoc/scripts/third-party/fuse.js
new file mode 100644
index 00000000..a55c5daa
--- /dev/null
+++ b/javadoc/scripts/third-party/fuse.js
@@ -0,0 +1,9 @@
+/**
+ * Fuse.js v6.4.6 - Lightweight fuzzy-search (http://fusejs.io)
+ *
+ * Copyright (c) 2021 Kiro Risk (http://kiro.me)
+ * All Rights Reserved. Apache Software License 2.0
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+var e,t;e=this,t=function(){"use strict";function e(t){return(e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(t)}function t(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function n(e,t){for(var n=0;ne.length)&&(t=e.length);for(var n=0,r=new Array(t);n0&&void 0!==arguments[0]?arguments[0]:3,t=new Map,n=Math.pow(10,e);return{get:function(e){var r=e.match(I).length;if(t.has(r))return t.get(r);var i=1/Math.sqrt(r),o=parseFloat(Math.round(i*n)/n);return t.set(r,o),o},clear:function(){t.clear()}}}var E=function(){function e(){var n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},r=n.getFn,i=void 0===r?A.getFn:r;t(this,e),this.norm=C(3),this.getFn=i,this.isCreated=!1,this.setIndexRecords()}return r(e,[{key:"setSources",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.docs=e}},{key:"setIndexRecords",value:function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.records=e}},{key:"setKeys",value:function(){var e=this,t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[];this.keys=t,this._keysMap={},t.forEach((function(t,n){e._keysMap[t.id]=n}))}},{key:"create",value:function(){var e=this;!this.isCreated&&this.docs.length&&(this.isCreated=!0,g(this.docs[0])?this.docs.forEach((function(t,n){e._addString(t,n)})):this.docs.forEach((function(t,n){e._addObject(t,n)})),this.norm.clear())}},{key:"add",value:function(e){var t=this.size();g(e)?this._addString(e,t):this._addObject(e,t)}},{key:"removeAt",value:function(e){this.records.splice(e,1);for(var t=e,n=this.size();t2&&void 0!==arguments[2]?arguments[2]:{},r=n.getFn,i=void 0===r?A.getFn:r,o=new E({getFn:i});return o.setKeys(e.map(_)),o.setSources(t),o.create(),o}function R(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=t.errors,r=void 0===n?0:n,i=t.currentLocation,o=void 0===i?0:i,c=t.expectedLocation,a=void 0===c?0:c,s=t.distance,u=void 0===s?A.distance:s,h=t.ignoreLocation,f=void 0===h?A.ignoreLocation:h,l=r/e.length;if(f)return l;var d=Math.abs(a-o);return u?l+d/u:d?1:l}function F(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:A.minMatchCharLength,n=[],r=-1,i=-1,o=0,c=e.length;o=t&&n.push([r,i]),r=-1)}return e[o-1]&&o-r>=t&&n.push([r,o-1]),n}function P(e){for(var t={},n=0,r=e.length;n1&&void 0!==arguments[1]?arguments[1]:{},o=i.location,c=void 0===o?A.location:o,a=i.threshold,s=void 0===a?A.threshold:a,u=i.distance,h=void 0===u?A.distance:u,f=i.includeMatches,l=void 0===f?A.includeMatches:f,d=i.findAllMatches,v=void 0===d?A.findAllMatches:d,g=i.minMatchCharLength,y=void 0===g?A.minMatchCharLength:g,p=i.isCaseSensitive,m=void 0===p?A.isCaseSensitive:p,k=i.ignoreLocation,M=void 0===k?A.ignoreLocation:k;if(t(this,e),this.options={location:c,threshold:s,distance:h,includeMatches:l,findAllMatches:v,minMatchCharLength:y,isCaseSensitive:m,ignoreLocation:M},this.pattern=m?n:n.toLowerCase(),this.chunks=[],this.pattern.length){var b=function(e,t){r.chunks.push({pattern:e,alphabet:P(e),startIndex:t})},x=this.pattern.length;if(x>32){for(var L=0,S=x%32,w=x-S;L3&&void 0!==arguments[3]?arguments[3]:{},i=r.location,o=void 0===i?A.location:i,c=r.distance,a=void 0===c?A.distance:c,s=r.threshold,u=void 0===s?A.threshold:s,h=r.findAllMatches,f=void 0===h?A.findAllMatches:h,l=r.minMatchCharLength,d=void 0===l?A.minMatchCharLength:l,v=r.includeMatches,g=void 0===v?A.includeMatches:v,y=r.ignoreLocation,p=void 0===y?A.ignoreLocation:y;if(t.length>32)throw new Error(L(32));for(var m,k=t.length,M=e.length,b=Math.max(0,Math.min(o,M)),x=u,S=b,w=d>1||g,_=w?Array(M):[];(m=e.indexOf(t,S))>-1;){var O=R(t,{currentLocation:m,expectedLocation:b,distance:a,ignoreLocation:p});if(x=Math.min(O,x),S=m+k,w)for(var j=0;j=K;J-=1){var T=J-1,U=n[e.charAt(T)];if(w&&(_[T]=+!!U),W[J]=(W[J+1]<<1|1)&U,P&&(W[J]|=(I[J+1]|I[J])<<1|1|I[J+1]),W[J]&$&&(C=R(t,{errors:P,currentLocation:T,expectedLocation:b,distance:a,ignoreLocation:p}))<=x){if(x=C,(S=T)<=b)break;K=Math.max(1,2*b-S)}}var V=R(t,{errors:P+1,currentLocation:b,expectedLocation:b,distance:a,ignoreLocation:p});if(V>x)break;I=W}var B={isMatch:S>=0,score:Math.max(.001,C)};if(w){var G=F(_,d);G.length?g&&(B.indices=G):B.isMatch=!1}return B}(e,n,i,{location:c+o,distance:a,threshold:s,findAllMatches:u,minMatchCharLength:h,includeMatches:r,ignoreLocation:f}),p=y.isMatch,m=y.score,k=y.indices;p&&(g=!0),v+=m,p&&k&&(d=[].concat(l(d),l(k)))}));var y={isMatch:g,score:g?v/this.chunks.length:1};return g&&r&&(y.indices=d),y}}]),e}(),D=function(){function e(n){t(this,e),this.pattern=n}return r(e,[{key:"search",value:function(){}}],[{key:"isMultiMatch",value:function(e){return z(e,this.multiRegex)}},{key:"isSingleMatch",value:function(e){return z(e,this.singleRegex)}}]),e}();function z(e,t){var n=e.match(t);return n?n[1]:null}var K=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=e===this.pattern;return{isMatch:t,score:t?0:1,indices:[0,this.pattern.length-1]}}}],[{key:"type",get:function(){return"exact"}},{key:"multiRegex",get:function(){return/^="(.*)"$/}},{key:"singleRegex",get:function(){return/^=(.*)$/}}]),i}(D),q=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=-1===e.indexOf(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,e.length-1]}}}],[{key:"type",get:function(){return"inverse-exact"}},{key:"multiRegex",get:function(){return/^!"(.*)"$/}},{key:"singleRegex",get:function(){return/^!(.*)$/}}]),i}(D),W=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=e.startsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,this.pattern.length-1]}}}],[{key:"type",get:function(){return"prefix-exact"}},{key:"multiRegex",get:function(){return/^\^"(.*)"$/}},{key:"singleRegex",get:function(){return/^\^(.*)$/}}]),i}(D),J=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=!e.startsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,e.length-1]}}}],[{key:"type",get:function(){return"inverse-prefix-exact"}},{key:"multiRegex",get:function(){return/^!\^"(.*)"$/}},{key:"singleRegex",get:function(){return/^!\^(.*)$/}}]),i}(D),T=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=e.endsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[e.length-this.pattern.length,e.length-1]}}}],[{key:"type",get:function(){return"suffix-exact"}},{key:"multiRegex",get:function(){return/^"(.*)"\$$/}},{key:"singleRegex",get:function(){return/^(.*)\$$/}}]),i}(D),U=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){var t=!e.endsWith(this.pattern);return{isMatch:t,score:t?0:1,indices:[0,e.length-1]}}}],[{key:"type",get:function(){return"inverse-suffix-exact"}},{key:"multiRegex",get:function(){return/^!"(.*)"\$$/}},{key:"singleRegex",get:function(){return/^!(.*)\$$/}}]),i}(D),V=function(e){a(i,e);var n=f(i);function i(e){var r,o=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},c=o.location,a=void 0===c?A.location:c,s=o.threshold,u=void 0===s?A.threshold:s,h=o.distance,f=void 0===h?A.distance:h,l=o.includeMatches,d=void 0===l?A.includeMatches:l,v=o.findAllMatches,g=void 0===v?A.findAllMatches:v,y=o.minMatchCharLength,p=void 0===y?A.minMatchCharLength:y,m=o.isCaseSensitive,k=void 0===m?A.isCaseSensitive:m,M=o.ignoreLocation,b=void 0===M?A.ignoreLocation:M;return t(this,i),(r=n.call(this,e))._bitapSearch=new N(e,{location:a,threshold:u,distance:f,includeMatches:d,findAllMatches:g,minMatchCharLength:p,isCaseSensitive:k,ignoreLocation:b}),r}return r(i,[{key:"search",value:function(e){return this._bitapSearch.searchIn(e)}}],[{key:"type",get:function(){return"fuzzy"}},{key:"multiRegex",get:function(){return/^"(.*)"$/}},{key:"singleRegex",get:function(){return/^(.*)$/}}]),i}(D),B=function(e){a(i,e);var n=f(i);function i(e){return t(this,i),n.call(this,e)}return r(i,[{key:"search",value:function(e){for(var t,n=0,r=[],i=this.pattern.length;(t=e.indexOf(this.pattern,n))>-1;)n=t+i,r.push([t,n-1]);var o=!!r.length;return{isMatch:o,score:o?0:1,indices:r}}}],[{key:"type",get:function(){return"include"}},{key:"multiRegex",get:function(){return/^'"(.*)"$/}},{key:"singleRegex",get:function(){return/^'(.*)$/}}]),i}(D),G=[K,B,W,J,U,T,q,V],H=G.length,Q=/ +(?=([^\"]*\"[^\"]*\")*[^\"]*$)/;function X(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};return e.split("|").map((function(e){for(var n=e.trim().split(Q).filter((function(e){return e&&!!e.trim()})),r=[],i=0,o=n.length;i1&&void 0!==arguments[1]?arguments[1]:{},i=r.isCaseSensitive,o=void 0===i?A.isCaseSensitive:i,c=r.includeMatches,a=void 0===c?A.includeMatches:c,s=r.minMatchCharLength,u=void 0===s?A.minMatchCharLength:s,h=r.ignoreLocation,f=void 0===h?A.ignoreLocation:h,l=r.findAllMatches,d=void 0===l?A.findAllMatches:l,v=r.location,g=void 0===v?A.location:v,y=r.threshold,p=void 0===y?A.threshold:y,m=r.distance,k=void 0===m?A.distance:m;t(this,e),this.query=null,this.options={isCaseSensitive:o,includeMatches:a,minMatchCharLength:u,findAllMatches:d,ignoreLocation:f,location:g,threshold:p,distance:k},this.pattern=o?n:n.toLowerCase(),this.query=X(this.pattern,this.options)}return r(e,[{key:"searchIn",value:function(e){var t=this.query;if(!t)return{isMatch:!1,score:1};var n=this.options,r=n.includeMatches;e=n.isCaseSensitive?e:e.toLowerCase();for(var i=0,o=[],c=0,a=0,s=t.length;a-1&&(n.refIndex=e.idx),t.matches.push(n)}}))}function le(e,t){t.score=e.score}function de(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r=n.includeMatches,i=void 0===r?A.includeMatches:r,o=n.includeScore,c=void 0===o?A.includeScore:o,a=[];return i&&a.push(fe),c&&a.push(le),e.map((function(e){var n=e.idx,r={item:t[n],refIndex:n};return a.length&&a.forEach((function(t){t(e,r)})),r}))}var ve=function(){function e(n){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},i=arguments.length>2?arguments[2]:void 0;t(this,e),this.options=c({},A,{},r),this.options.useExtendedSearch,this._keyStore=new w(this.options.keys),this.setCollection(n,i)}return r(e,[{key:"setCollection",value:function(e,t){if(this._docs=e,t&&!(t instanceof E))throw new Error("Incorrect 'index' type");this._myIndex=t||$(this.options.keys,this._docs,{getFn:this.options.getFn})}},{key:"add",value:function(e){k(e)&&(this._docs.push(e),this._myIndex.add(e))}},{key:"remove",value:function(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:function(){return!1},t=[],n=0,r=this._docs.length;n1&&void 0!==arguments[1]?arguments[1]:{},n=t.limit,r=void 0===n?-1:n,i=this.options,o=i.includeMatches,c=i.includeScore,a=i.shouldSort,s=i.sortFn,u=i.ignoreFieldNorm,h=g(e)?g(this._docs[0])?this._searchStringList(e):this._searchObjectList(e):this._searchLogical(e);return he(h,{ignoreFieldNorm:u}),a&&h.sort(s),y(r)&&r>-1&&(h=h.slice(0,r)),de(h,this._docs,{includeMatches:o,includeScore:c})}},{key:"_searchStringList",value:function(e){var t=te(e,this.options),n=this._myIndex.records,r=[];return n.forEach((function(e){var n=e.v,i=e.i,o=e.n;if(k(n)){var c=t.searchIn(n),a=c.isMatch,s=c.score,u=c.indices;a&&r.push({item:n,idx:i,matches:[{score:s,value:n,norm:o,indices:u}]})}})),r}},{key:"_searchLogical",value:function(e){var t=this,n=function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r=n.auto,i=void 0===r||r,o=function e(n){var r=Object.keys(n),o=ae(n);if(!o&&r.length>1&&!ce(n))return e(ue(n));if(se(n)){var c=o?n[ie]:r[0],a=o?n[oe]:n[c];if(!g(a))throw new Error(x(c));var s={keyId:j(c),pattern:a};return i&&(s.searcher=te(a,t)),s}var u={children:[],operator:r[0]};return r.forEach((function(t){var r=n[t];v(r)&&r.forEach((function(t){u.children.push(e(t))}))})),u};return ce(e)||(e=ue(e)),o(e)}(e,this.options),r=this._myIndex.records,i={},o=[];return r.forEach((function(e){var r=e.$,c=e.i;if(k(r)){var a=function e(n,r,i){if(!n.children){var o=n.keyId,c=n.searcher,a=t._findMatches({key:t._keyStore.get(o),value:t._myIndex.getValueForItemAtKeyId(r,o),searcher:c});return a&&a.length?[{idx:i,item:r,matches:a}]:[]}switch(n.operator){case ne:for(var s=[],u=0,h=n.children.length;u1&&void 0!==arguments[1]?arguments[1]:{},n=t.getFn,r=void 0===n?A.getFn:n,i=e.keys,o=e.records,c=new E({getFn:r});return c.setKeys(i),c.setIndexRecords(o),c},ve.config=A,function(){ee.push.apply(ee,arguments)}(Z),ve},"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e=e||self).Fuse=t();
\ No newline at end of file
diff --git a/javadoc/scripts/third-party/hljs-line-num-original.js b/javadoc/scripts/third-party/hljs-line-num-original.js
new file mode 100644
index 00000000..9b8e18f7
--- /dev/null
+++ b/javadoc/scripts/third-party/hljs-line-num-original.js
@@ -0,0 +1,369 @@
+// jshint multistr:true
+
+(function (w, d) {
+ 'use strict';
+
+ var TABLE_NAME = 'hljs-ln',
+ LINE_NAME = 'hljs-ln-line',
+ CODE_BLOCK_NAME = 'hljs-ln-code',
+ NUMBERS_BLOCK_NAME = 'hljs-ln-numbers',
+ NUMBER_LINE_NAME = 'hljs-ln-n',
+ DATA_ATTR_NAME = 'data-line-number',
+ BREAK_LINE_REGEXP = /\r\n|\r|\n/g;
+
+ if (w.hljs) {
+ w.hljs.initLineNumbersOnLoad = initLineNumbersOnLoad;
+ w.hljs.lineNumbersBlock = lineNumbersBlock;
+ w.hljs.lineNumbersValue = lineNumbersValue;
+
+ addStyles();
+ } else {
+ w.console.error('highlight.js not detected!');
+ }
+
+ function isHljsLnCodeDescendant(domElt) {
+ var curElt = domElt;
+ while (curElt) {
+ if (curElt.className && curElt.className.indexOf('hljs-ln-code') !== -1) {
+ return true;
+ }
+ curElt = curElt.parentNode;
+ }
+ return false;
+ }
+
+ function getHljsLnTable(hljsLnDomElt) {
+ var curElt = hljsLnDomElt;
+ while (curElt.nodeName !== 'TABLE') {
+ curElt = curElt.parentNode;
+ }
+ return curElt;
+ }
+
+ // Function to workaround a copy issue with Microsoft Edge.
+ // Due to hljs-ln wrapping the lines of code inside a
element,
+ // itself wrapped inside a
element, window.getSelection().toString()
+ // does not contain any line breaks. So we need to get them back using the
+ // rendered code in the DOM as reference.
+ function edgeGetSelectedCodeLines(selection) {
+ // current selected text without line breaks
+ var selectionText = selection.toString();
+
+ // get the
element wrapping the first line of selected code
+ var tdAnchor = selection.anchorNode;
+ while (tdAnchor.nodeName !== 'TD') {
+ tdAnchor = tdAnchor.parentNode;
+ }
+
+ // get the
element wrapping the last line of selected code
+ var tdFocus = selection.focusNode;
+ while (tdFocus.nodeName !== 'TD') {
+ tdFocus = tdFocus.parentNode;
+ }
+
+ // extract line numbers
+ var firstLineNumber = parseInt(tdAnchor.dataset.lineNumber);
+ var lastLineNumber = parseInt(tdFocus.dataset.lineNumber);
+
+ // multi-lines copied case
+ if (firstLineNumber != lastLineNumber) {
+
+ var firstLineText = tdAnchor.textContent;
+ var lastLineText = tdFocus.textContent;
+
+ // if the selection was made backward, swap values
+ if (firstLineNumber > lastLineNumber) {
+ var tmp = firstLineNumber;
+ firstLineNumber = lastLineNumber;
+ lastLineNumber = tmp;
+ tmp = firstLineText;
+ firstLineText = lastLineText;
+ lastLineText = tmp;
+ }
+
+ // discard not copied characters in first line
+ while (selectionText.indexOf(firstLineText) !== 0) {
+ firstLineText = firstLineText.slice(1);
+ }
+
+ // discard not copied characters in last line
+ while (selectionText.lastIndexOf(lastLineText) === -1) {
+ lastLineText = lastLineText.slice(0, -1);
+ }
+
+ // reconstruct and return the real copied text
+ var selectedText = firstLineText;
+ var hljsLnTable = getHljsLnTable(tdAnchor);
+ for (var i = firstLineNumber + 1 ; i < lastLineNumber ; ++i) {
+ var codeLineSel = format('.{0}[{1}="{2}"]', [CODE_BLOCK_NAME, DATA_ATTR_NAME, i]);
+ var codeLineElt = hljsLnTable.querySelector(codeLineSel);
+ selectedText += '\n' + codeLineElt.textContent;
+ }
+ selectedText += '\n' + lastLineText;
+ return selectedText;
+ // single copied line case
+ } else {
+ return selectionText;
+ }
+ }
+
+ // ensure consistent code copy/paste behavior across all browsers
+ // (see https://github.com/wcoder/highlightjs-line-numbers.js/issues/51)
+ document.addEventListener('copy', function(e) {
+ // get current selection
+ var selection = window.getSelection();
+ // override behavior when one wants to copy line of codes
+ if (isHljsLnCodeDescendant(selection.anchorNode)) {
+ var selectionText;
+ // workaround an issue with Microsoft Edge as copied line breaks
+ // are removed otherwise from the selection string
+ if (window.navigator.userAgent.indexOf('Edge') !== -1) {
+ selectionText = edgeGetSelectedCodeLines(selection);
+ } else {
+ // other browsers can directly use the selection string
+ selectionText = selection.toString();
+ }
+ e.clipboardData.setData(
+ 'text/plain',
+ selectionText
+ .replace(/(^\t)/gm, '')
+ );
+ e.preventDefault();
+ }
+ });
+
+ function addStyles () {
+ var css = d.createElement('style');
+ css.type = 'text/css';
+ css.innerHTML = format(
+ '.{0}{border-collapse:collapse}' +
+ '.{0} td{padding:0}' +
+ '.{1}:before{content:attr({2})}',
+ [
+ TABLE_NAME,
+ NUMBER_LINE_NAME,
+ DATA_ATTR_NAME
+ ]);
+ d.getElementsByTagName('head')[0].appendChild(css);
+ }
+
+ function initLineNumbersOnLoad (options) {
+ if (d.readyState === 'interactive' || d.readyState === 'complete') {
+ documentReady(options);
+ } else {
+ w.addEventListener('DOMContentLoaded', function () {
+ documentReady(options);
+ });
+ }
+ }
+
+ function documentReady (options) {
+ try {
+ var blocks = d.querySelectorAll('code.hljs,code.nohighlight');
+
+ for (var i in blocks) {
+ if (blocks.hasOwnProperty(i)) {
+ if (!isPluginDisabledForBlock(blocks[i])) {
+ lineNumbersBlock(blocks[i], options);
+ }
+ }
+ }
+ } catch (e) {
+ w.console.error('LineNumbers error: ', e);
+ }
+ }
+
+ function isPluginDisabledForBlock(element) {
+ return element.classList.contains('nohljsln');
+ }
+
+ function lineNumbersBlock (element, options) {
+ if (typeof element !== 'object') return;
+
+ async(function () {
+ element.innerHTML = lineNumbersInternal(element, options);
+ });
+ }
+
+ function lineNumbersValue (value, options) {
+ if (typeof value !== 'string') return;
+
+ var element = document.createElement('code')
+ element.innerHTML = value
+
+ return lineNumbersInternal(element, options);
+ }
+
+ function lineNumbersInternal (element, options) {
+
+ var internalOptions = mapOptions(element, options);
+
+ duplicateMultilineNodes(element);
+
+ return addLineNumbersBlockFor(element.innerHTML, internalOptions);
+ }
+
+ function addLineNumbersBlockFor (inputHtml, options) {
+ var lines = getLines(inputHtml);
+
+ // if last line contains only carriage return remove it
+ if (lines[lines.length-1].trim() === '') {
+ lines.pop();
+ }
+
+ if (lines.length > 1 || options.singleLine) {
+ var html = '';
+
+ for (var i = 0, l = lines.length; i < l; i++) {
+ html += format(
+ '
