domain_example.py

#
# Copyright (c) 2018-2026 LabKey Corporation
#
# 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.
#
from labkey.api_wrapper import APIWrapper
from labkey.domain import conditional_format
from labkey.query import QueryFilter

labkey_server = "localhost:8080"
container_path = "Tutorials/HIV Study" # Full project/folder container path
context_path = "labkey"
api = APIWrapper(labkey_server, container_path, context_path, use_ssl=False)

###################
# Create a list domain
###################
list_domain_definition = {
 "kind": "IntList", # or 'VarList'
 "domainDesign": {
 "name": "BloodTypes",
 "description": "All known human blood types",
 "fields": [
 {"name": "rowId", "rangeURI": "int"},
 {"name": "type", "rangeURI": "string"},
 ],
 },
 # 'options' allows for passing properties specific to a domain type (e.g. list, dataset, etc)
 "options": {"keyName": "rowId", "keyType": "AutoIncrementInteger"},
}

# api.domain.create returns the full Domain definition
created_list_domain = api.domain.create(list_domain_definition)

###################
# Create a study dataset domain
###################
dataset_domain_definition = {
 "kind": "StudyDatasetDate", # or 'StudyDatasetVisit'
 "domainDesign": {
 "name": "Blood Levels",
 "fields": [
 {"name": "vitd", "label": "Vitamin D (ng/mL)", "rangeURI": "double"},
 {
 "name": "type",
 "rangeURI": "int",
 "lookupSchema": "lists",
 "lookupQuery": "BloodTypes",
 "setMeasure": True,
 },
 ],
 },
}

dataset_domain = api.domain.create(dataset_domain_definition)

###################
# Get a domain and it's associated options
###################
list_domain, list_domain_options = api.domain.get_domain_details("lists", "BloodTypes")

# examine different from the domain
print(list_domain.name)
print(list_domain.fields[0].name)

###################
# Save a domain
###################
list_domain.add_field({"name": "canTransfuse", "rangeURI": "boolean"})

# Use infer fields to define additional fields
fields_file = open("data/infer.tsv", "rb")
inferred_fields = api.domain.infer_fields(fields_file)

# Update the description via domain options
list_domain_options["description"] = "Contains all known human blood types"

for field in inferred_fields:
 list_domain.add_field(field)

api.domain.save("lists", "BloodTypes", list_domain, options=list_domain_options)

###################
# Drop a domain
###################
drop_response = api.domain.drop("study", "Blood Levels")
if "success" in drop_response:
 print("The dataset domain was deleted.")

drop_response = api.domain.drop("lists", "BloodTypes")
if "success" in drop_response:
 print("The list domain was deleted.")

###################
# Create a domain with a conditional format
###################
list_with_cf = {
 "kind": "IntList",
 "domainDesign": {
 "name": "ListWithConditionalFormats",
 "description": "Test list",
 "fields": [
 {"name": "rowId", "rangeURI": "int"},
 {
 "name": "date",
 "rangeURI": "date",
 "conditionalFormats": [
 {
 "filter": [
 QueryFilter(
 "date",
 "10/29/1995",
 QueryFilter.Types.DATE_GREATER_THAN,
 ),
 QueryFilter("date", "10/31/1995", QueryFilter.Types.DATE_LESS_THAN),
 ],
 "textcolor": "f44e3b",
 "backgroundcolor": "fcba03",
 "bold": True,
 "italic": False,
 "strikethrough": False,
 }
 ],
 },
 {
 "name": "age",
 "rangeURI": "int",
 "conditionalFormats": [
 {
 "filter": QueryFilter("age", 500, QueryFilter.Types.GREATER_THAN),
 "textcolor": "f44e3b",
 "backgroundcolor": "fcba03",
 "bold": True,
 "italic": True,
 "strikethrough": False,
 }
 ],
 },
 ],
 },
 "options": {"keyName": "rowId", "keyType": "AutoIncrementInteger"},
}

domain_cf = api.domain.create(list_with_cf)

###################
# Edit an existing domain's conditional format
###################
age_field = list(filter(lambda domain_field: domain_field.name == "age", domain_cf.fields))[0]
print(
 'The filter on field "' + age_field.name + '" was: ' + age_field.conditional_formats[0].filter
)

for field in domain_cf.fields:
 if field.name == "age":
 cf = conditional_format(query_filter="format.column~eq=30", text_color="ff0000")
 field.conditional_formats = [cf]
 if field.name == "date":
 cf = conditional_format(
 query_filter=QueryFilter("date", "10/30/1995", QueryFilter.Types.DATE_LESS_THAN),
 text_color="f44e3b",
 )
 field.conditional_formats = [cf]

api.domain.save("lists", "ListWithConditionalFormats", domain_cf)
print(
 'The filter on field "'
 + age_field.name
 + '" has been updated to: '
 + age_field.conditional_formats[0].filter
)

###################
# Delete a domain's conditional format
###################
for field in domain_cf.fields:
 if field.name == "age":
 field.conditional_formats = []

# Cleanup
api.domain.drop("lists", "ListWithConditionalFormats")