JavaScript Client Libraries (ERMrestJS)

ERMrestJS User Documents

• Base Model Annotation
  • Notation and Usage
    • Example to Set Annotation
  • Annotations
    • Tag: 2015 Display
      • Tag: 2015 Display Settings Hierarchy
      • Heuristics
    • Tag: 2016 App Links
    • Tag: 2016 Immutable
    • Tag: 2016 Generated
    • Tag: 2016 Non Deletable
    • Tag: 2016 Visible Columns
    • Tag: 2017 Key Display
    • Tag: 2016 Foreign Key
    • Tag: 2016 Column Display
    • Tag: 2016 Table Display
      • Table Display Settings Hierarchy
    • Tag: 2016 Visible Foreign Keys
    • Tag: 2016 Table Alternatives
    • Tag: 2019 Export
      • Export Annotation Hierarchy
      • Heurisistics
    • Tag: 2017 Asset
    • Tag: 2018 Citation
    • Tag: 2018 Required
    • Tag: 2018 Indexing Preferences
    • Tag: 2019 Chaise Config
    • Tag: 2019 Source Definitions
    • Tag: 2021 Google Dataset
    • Tag: 2021 Table Config
    • Tag: 2021 Export Fragment Definitions
    • Tag: 2023 Column Defaults
  • Context Names
  • Pattern Expansion
  • Column Directive
    • Overall structure
    • Properties
      • 1. Data source properties
      • 2. Presentation properties
• Annotation Contexts Used By Chaise
• Template and Markdown Guide
  • Using annotations to create templates with Markdown
  • Mustache Templating
    • Table of contents
    • Variables
      • Usage
      • Raw Values
      • Foreign Key Values
      • Encoding variables for URL manipulation
      • Escaping Content
    • Examples
      • 1. Normal replacement - “{{{name}}}”
      • 2. Replacement with URL encoding - “{{#encode}}{{{name}}}{{/encode}}”
      • 3. Replacement with HTML escaping - “{{name}}”
      • 4. Replacement with null check, disabled escaping and url encoding - “{{#name}}…{{/name}}”
      • 5. Replacement with negated-null check - “{{^name}}…{{/name}}”
      • 6. Null Handling
      • Using Pre-defined Attributes
  • Handlebars Templating
    • Table of contents
    • Handlebars vs. Mustache
      • Null checking
      • Encode syntax
      • Restriction in the adjacency of opening and closing tags
    • Usage
      • Handlebars Paths
      • Automatic null detection
      • Accessing current context
      • HTML-escaping
      • Using Arrays
      • Escaping Handlebars expressions
      • Accessing keys with spaces and special characters
      • Subexpressions
    • Using Pre-defined Attributes
      • $moment
      • $catalog
      • $dcctx
      • $location
      • $session
    • Helpers
      • formatDate helper
      • humanizeBytes helper
      • Math Helpers
    • Block Helpers
      • If helper
      • Unless helper
      • Each helper
      • With helper
      • Lookup helper
      • Encode helper
      • Escape helper
      • Encodefacet helper
      • JsonStringify helper
      • Findfirst helper
      • Findall helper
      • Replace helper
      • ToTitleCase helper
    • Boolean Helpers
      • Comparison Helpers
      • Regular Expression Match
      • Logical Helpers
  • Markdown Formatting
    • Table of Contents
    • Inline Vs. Block
    • Attributes
      • Tooltip
      • Classes
    • Examples
      • 1. Link (Anchor)
      • 2. Download Button
      • 3. Image
      • 4. Thumbnail With Link To Original Image And A caption
      • 5. Image with zoom capabilties
      • 6. Iframe
      • 7. Dropdown download button
      • 8. Vocabulary
      • 9. Youtube Video
      • 10. Video
      • 11. Subscript
      • 12. Superscript
      • 13. Span (Attach Attributes To Text)
      • 14. Escape markdown content
      • 15. RID link
      • 16. Table
• PreFormat Column Value
  • Syntax
    • Flags field:
    • Width field
    • Precision Field
    • Type Field
    • Named arguments:
  • Examples:
  • Syntax for Dates and Timestamps
    • Most common Year, Month, and Day tokens:
    • Most common Hour, minute, second, millisecond, and offset tokens:
• Facet JSON Structure
  • Structure
  • Logical operators
  • Source path
  • Source key
  • Fast filter source
  • Constraints
  • Extra properties
    • entity v.s. scalar facet
    • markdown_name
    • comment
      • open
      • ux_mode
    • hide_null_choice/hide_not_null_choice
    • bar_plot
    • order
  • hide_num_occurrences
  • Examples
    • Example 1
    • Example 2
    • Example 3 (Entity vs. Scalar)
    • Example 4 (Choice Vs. Range)
    • Example 5 (Facet Title)
    • Example 6 (Open Vs. Close)
    • Example 7 (Change order of scalar values)
• Column Directive
  • Table of contents
  • Overall structure
    • 1. Column directive with source
    • 2. Column directive with sourcekey
    • 3. Column directive without any source
  • Properties
    • 1. Data source properties
      • source
      • sourcekey
      • entity
      • aggregate
    • 2. Presentation properties
      • markdown_name
      • comment
      • comment_render_markdown
      • comment_display
      • hide_column_header
      • self-link
      • display
      • array_options
      • Displayname
      • Value
      • Sort
      • input_iframe
  • Shorthand syntax
  • Examples
    • Visible Column List
    • Visible ForeignKey List
    • Alternative syntax
• Column Directive Display
  • Accessing Column Directive Values Using By Utilizing Source Definitions
  • Accessing Current Column Directive Data
    • $self Data Structure
    • Examples
• Column directive in templating environments
  • 1. Defining sources
  • 2. Defining column directive display
    • Accessing columns and fkeys
    • Accessing sources (wait_for)
      • Column directive templating variable data structure
  • Examples
• Input iframe
  • Iframe communication
  • Annotation
    • url_pattern
    • field_mapping
    • optional_fields
    • empty_field_confirm_message_markdown
• Table Alternatives
  • Definition and assumptions
  • Related Entities
  • Understanding Recordset
  • ERMrestJS Restrictions
  • Faceting
    • 1. Alternative Table For Main Table
      • Scenario 1 - Faceting Annotation
      • Scenario 2 - Heuristics (Without Faceting annotation)
    • 2. Alternative Table in Facet List
      • Scenario 1: Entity facet with alternative table for compact/select
      • Scenario 2: Table With Alternative For compact/select, Facet on Another Alternative Table (Not supported)
      • Scenario 3: Table Without Alternative For compact/select, Facet on Another Alternative Table (Not supported)
• Export Annotation
  • Table of contents
  • Export Templates
    • Overall structure
    • Details
      • root (object)
      • template (object)
      • output (object)
      • source (object)
      • destination (object)
      • type
  • How it works
  • Default templates
    • Default BDBag template
    • Default CSV template
    • How visible-columns is turned into export
  • Examples
    • Example 1
    • Example 2
    • Example 3
    • Example 4
    • Example 5
    • Example 6
• Google dataset annotation
  • Expected Fields
  • Guidelines