Labii Documentation
HomeFree SignupFree DemoContact Us
  • Getting Started
    • Introduction
    • Quick Start
  • User Guide
    • Interface
      • Side Menu
      • Views
    • Add Record
      • Add a project
      • Add a blank record
      • Add records in bulk
      • Add a record from a template
      • Add record(s) from file(s)
      • Add a template
    • Record List View
      • Table List View
      • Project List View
      • Row List View
      • ❗Import Records
      • Export Records
      • Bulk Operations
        • Bulk Edit Columns
        • Bulk Edit Sections
        • Bulk Print Detail
        • Bulk Print Labels
        • Bulk Print Barcodes
        • Bulk Print QR Codes
        • Bulk Download
        • Use Selected to Add Blank Record
        • Use Selected to Bulk Add Records
    • Record Detail View
      • Columns
      • Sections
      • Notes
      • Signers
      • Versions
      • Activities
      • Visitors
      • Permissions
      • Section
      • Actions
        • Sign
        • Print
        • Share
    • Navbar
      • Search
        • Global search
        • Search at list view
        • Search query
      • Scan
    • Side Menu
      • Dashboard
      • Calendar
      • Notifications
      • Reload Organization
      • Switch Organization
      • Change Data Center
    • Accounts
      • Authentication
      • Setup an account
      • Create an account
      • My Profile
    • AI Integration
      • Prompt box
      • Prompt template
      • ProtocolGPT
      • AI in Widgets
      • Use cases
  • Admin Guide
    • Organization
    • Backups
    • Personnel
    • Certifications
    • Teams
    • Projects
      • Members
    • Applications
    • Tables
      • Columns
      • Sections
      • Filters
    • Workflows
    • Widgets
    • Subscriptions
    • Credits
    • Invoices
    • Single Sign On
      • Google G Suite
      • Okta
      • OneLogin
      • Microsoft Azure
    • API Keys
  • Widgets
    • Overview
    • Column Widgets
      • Form
        • Text inputs
          • Text
          • MultilineText
          • RichText
          • Number
          • RangeUnit
          • Email
          • Phone
          • Secret
          • Link
          • Address
        • Boolean
          • Checkbox
          • Switch
        • DateTime
          • Date
          • Time
          • DateTime
          • Appointment
          • TimeStamp
          • Timezone
        • Dropdown
          • Select
          • MultiSelect
          • ForeignKey
          • ForeignKeys
          • Member
          • Members
        • File
          • Files
          • Image
          • File Path
          • File Size
          • File Antivirus Status
      • Barcode
        • Barcode
        • QR Code
      • Calculation
        • Formula
        • Numbering
        • RowCount
        • Consumption
      • Integration
        • API
          • API
        • Dropdown
          • API ForeignKey
          • API ForeignKeys
      • Column
        • Record Citation
        • Column Citation
        • Column Data
        • Column Addition
      • Regulation
        • Signature
          • Signature
          • Open Signature
          • Signature Status
      • ❗Chemistry
      • ❗PubMed
      • ❗Device
      • ❗Integration
      • Advanced
        • Subtitle
        • Rating
        • Nested Fields
        • Storage Coordinates
    • Section Widgets
      • Office
        • Text
          • Plain Text
          • CKEditor Classic
          • CKEditor Balloon
          • CKEditor Document
          • CKEditor Restricted
          • CKEditor Classic Controlled
          • Code Editor
        • ❗Table
        • File
          • Files
          • File Preview
        • Google Drive
        • Drawing
        • G Suite
        • Microsoft Office
      • Data Display
        • Columns
          • Columns
          • Metadata
        • Sections
          • Section Display By Record
          • Section Display By ForeignKey
        • Record List
          • Record List
          • Record List by Column
          • Record List by ForeignKey
          • Record List by Query
      • ✅Regulation
        • Signers
        • ✅Audit Trail
          • ✅Activities
          • Versions
          • Visitors
      • Process Management
        • Flowchart
        • Steps
      • Diagram
        • Mermaid
        • Gantt Chart
        • Stage Flowchart
        • Relation Flowchart
      • Reference Manager
      • Biology
        • Plasmid Editor
        • Open Vector Editor
        • Microplate
          • 6-Well Plate
          • 12-Well Plate
          • 24-Well Plate
          • 48-Well Plate
          • 96-Well Plate
          • 384-Well Plate
          • Flexible Well Plate
        • Sample Aliquoting
        • Assay
          • ELISA Standard Curve
          • ELISA Qualitative
          • Dose Response Curve
        • Protein
          • MolStar
          • RCSB Saguaro
        • Bioinformatics
          • QUiCKR Analysis
          • CRISPResso2
      • Chemistry
        • Chemical Formats
        • Chemical Drawing
        • Chemical Analysis
        • Chemical Reaction
      • Combination
        • Clinical Genomicist Workstation
      • Productivity
        • ✅Calendars
          • Calendar
          • Scheduling
        • Automation
          • Workflows
        • Ungrouped
          • Storage Map
        • Table of Contents
        • Communication
          • Email Template
          • Notifications
          • Comments
        • Barcode
        • ToDo
        • Timer
      • Report
        • Record Summary
          • Record Summary
        • Data Driven Charts
          • Chart By Category X
          • Chart By Numeric X
        • Custom Input Charts
          • Data Visualizer
    • Dashboard Widgets
      • Labii
      • Shortcut
        • Applications
        • Links
        • Filters
      • Productivity
        • Office
        • Flowchart
        • Section
        • Project Management
          • ✅Tasks
        • Summary
      • ✅Reports
        • Record Summary
          • Record Summary By Date
          • Record Summary By Tables
          • Record Summary By Projects
          • Record Summary By Users
        • Data Driven Charts
          • Chart By Category X
          • Chart By Numeric X
        • Matrix
          • Record Count By Filter
        • Audit
          • Storage Audit
      • Integration
        • Quickbooks
          • Quickbooks Customers
          • Quickbooks Accounts
          • Quickbooks Items
          • Quickbooks Invoices
  • API
    • Concepts
      • How to get token from Labii ELN & LIMS
      • How can I load Labii data from API into DataFrame
    • Methods
      • Authentication
      • Notification
      • Organization
      • Personnel
      • Team
      • Organization Widget
      • Statement
      • Backup
      • Project
      • Member
      • Table
      • Column
      • Filter
      • Row
      • Cell
      • Section
      • Activity
      • Version
      • Visitor
      • Workflow
      • Step
      • Widget
    • Variables
    • SDK
      • API Client (python)
      • API Client (javascript)
      • SDK (python)
      • SDK (javascript)
      • Examples
  • Applications
    • Electronic Lab Notebook
      • ELN for Research and Development
      • ELN for Production
      • ELN for ELISA Data Analysis
      • ELN for Dose Response Curve
    • Process Management
      • ❗Report creating process in diagnosis testing
      • ❗Email follow up process in CRM
      • ❗Management of the purchasing, approval, and ordering processes.
    • Sample Management
      • Sample Receiving
      • Track sample consumption
      • Aliquots Management
    • Equipment Management
      • ❗Equipment Scheduling
      • ❗Equipment Maintenance
    • Inventory Management
      • Barcode System
      • Stock Checkin and Checkout
      • Storage Management
      • ❗Purchase Management
    • Laboratory Information Management System
      • LIMS for Sample Testing
      • LIMS for NGS
    • Customer Relationship Management (CRM)
      • Quickbooks Integration
    • Document Management
    • Chemical Registration
    • Mouse Colony Management
    • Diagnostic Testing
    • Diabetes Tracker
    • Project Management
      • Task Management
      • How to manage research goals
    • Reference Management
    • Training Management
  • Support
    • Overview
    • Documentation
    • YouTube
    • Videos
    • Tickets
    • Chat with us
    • Schedule a meeting
    • Take a survey
    • Resources
    • Download
    • Blogs
    • FAQ
    • Other
      • Guidelines for Preparing Documents on Research Needs for Labii Configuration
Powered by GitBook
On this page
  • Overview
  • Installation
  • Quick start
  • Syntax
  • Labii
  • Object
  • Method
  • Props
  • Examples
  1. API
  2. SDK

SDK (javascript)

Overview

Labii SDK for JavaScript is a software development kit (SDK) that provides a set of tools and libraries for developing web applications using the Labii platform. The Labii platform is a cloud-based platform that allows researchers to manage their research data and workflow, including data collection, storage, analysis, and sharing.

The Labii SDK for JavaScript allows developers to integrate Labii's features and functionality into their web applications. It includes a variety of APIs that allow developers to access and manipulate data stored on the Labii platform, such as data entry forms, project management tools, and reporting features.

The SDK includes a JavaScript library that provides a high-level interface for interacting with the Labii API. It also includes a set of documentation and examples to help developers get started with using the SDK and integrating it into their applications.

Installation

To use the Labii SDK in your JavaScript project, you can install it using npm. Run the following command in your terminal (coming soon):

npm install labii-sdk

Quick start

Here's a quick start documentation for the Labii SDK:

  1. Importing the Labii SDK: After installing the Labii SDK, you can import it into your JavaScript code using the following syntax: import Labii from 'labii-sdk';

  2. Listing Rows: To list rows from a Labii project, you can use the list() method of the Row object. The list() method takes a configuration object as its argument, which specifies various options for the query.

Labii.Row.list({
	serializer: 'name',
	query: `table__sid=${table.sid.get()}`,
	callback_success: (response)=>{
		// code for success
	},
	callback_fail: (err)=>{
		// code for fail
	}
})

Syntax

Labii SDK syntax follows the pattern of Labii.[Object].[method]({props}).

Labii

This is the main object of the Labii SDK. It provides access to all of the other objects and methods in the SDK.

Object

This refers to one of the objects available in the Labii SDK, such as Project, Table, or Row. Each object represents a different type of entity in the Labii platform, and provides a set of methods for interacting with that entity.

Method

This is a function or action that can be performed on an object in the Labii platform. Each object in the Labii SDK has its own set of methods that can be used to perform various actions, such as creating a new project, adding a new experiment, or listing rows of data.

  1. list(): This method is used to retrieve a list of entities from the Labii platform, such as projects, experiments, or rows. The method takes a configuration object as its argument, which can be used to specify the filter, sorting, and pagination options for the list. The method returns a Promise that resolves with the list of entities when the request is successful.

  2. create(): This method is used to create a new entity in the Labii platform, such as a new project, experiment, or row. The method takes a configuration object as its argument, which should contain the properties of the new entity to be created. The method returns a Promise that resolves with the newly created entity when the request is successful.

  3. retrieve(): This method is used to retrieve a single entity from the Labii platform, based on its ID or other identifying information. The method takes a configuration object as its argument, which should contain the ID or other identifying information of the entity to be retrieved. The method returns a Promise that resolves with the retrieved entity when the request is successful.

  4. modify(): This method is used to modify an existing entity in the Labii platform, based on its ID or other identifying information. The method takes a configuration object as its argument, which should contain the properties of the entity to be modified. The method returns a Promise that resolves with the modified entity when the request is successful.

  5. delete(): This method is used to delete an existing entity from the Labii platform, based on its ID or other identifying information. The method takes a configuration object as its argument, which should contain the ID or other identifying information of the entity to be deleted. The method returns a Promise that resolves with the deleted entity when the request is successful.

Props

These are the properties or options that can be passed to a method when it is called. Props are used to configure the behavior of a method or to provide additional information to the Labii platform. For example, when calling the Project.create() method, you might pass props such as the project name, description, and owner.

  • List URL props:

    • sid (str, optional, default to organization.sid)

    • query (str, optional)

  • callback_success (func, optional). This props specifies a callback function to be called when the request is successful. The function receives the response data as its argument

  • callback_fail (func, optional). This option specifies a callback function to be called when the request fails. The function receives the error object as its argument

  • List URL props:

    • sid (str, optional, default to organization.sid)

    • query (str, optional)

  • callback_success (func, optional). This props specifies a callback function to be called when the request is successful. The function receives the response data as its argument

  • callback_fail (func, optional). This option specifies a callback function to be called when the request fails. The function receives the error object as its argument

  • List URL props:

    • sid (str, required).

    • query (str, optional)

  • callback_success (func, optional). This props specifies a callback function to be called when the request is successful. The function receives the response data as its argument

  • callback_fail (func, optional). This option specifies a callback function to be called when the request fails. The function receives the error object as its argument

  • List URL props:

    • sid (str, required).

    • query (str, optional)

  • callback_success (func, optional). This props specifies a callback function to be called when the request is successful. The function receives the response data as its argument

  • callback_fail (func, optional). This option specifies a callback function to be called when the request fails. The function receives the error object as its argument

  • List URL props:

    • sid (str, required).

    • query (str, optional)

  • callback_success (func, optional). This props specifies a callback function to be called when the request is successful. The function receives the response data as its argument

  • callback_fail (func, optional). This option specifies a callback function to be called when the request fails. The function receives the error object as its argument

Examples

PreviousSDK (python)NextExamples

Last updated 2 years ago

Please refer to for a list of Labii objects.

level (str, optional, default to organization). Learn more at .

serializer (str, optional, default to detail). Learn more at .

level (str, optional, default to organization). Learn more at .

serializer (str, optional, default to detail). Learn more at .

Objects
here
here
here
here