Welcome to Omni’s repository of all knowledge

General tips

[description]

• Omni Calculator’s handbook for calculatorians©
  • Most useful links
    • Omni links
    • Text writing
    • Dictionaries
  • Copy-paste stuff
    • Unicode symbols
    • Tables
    • Pictures
      • How to resize an image?
  • AdminBB
    • Calculators
      • Search panel
      • Filters
      • Columns
      • Editing and deleting calculator
    • Categories
    • Collections
    • Unit switchers
      • Units’ attributes
      • Add Unit Switcher
      • Unit Switchers naming convention
    • Tools
  • Calculator page
    • Quick links, page age and locale
      • Quick links
      • Page age
      • Overwrite locale data
    • Table of contents
    • Search bar
    • Check out similar calculators
  • Edit calculator
    • Upper panel, shortcut, preview
      • Save button
      • Calculator tools ⚙️
        • Clone
        • Merge to other calculator
      • Preview
    • Details
      • Slug
        • Slug rules
      • Name
        • Name rules
      • Purpose
      • Authors
      • Category and subcategory
      • Kind
      • Show ads
      • Parent of redundant calculator
      • Is published
    • Equations
      • Always save after making changes to the equations section
      • Additional variable names field
      • Variable names
      • Reserved variable names
      • Constants
      • Operators
      • Math functions
        • Trigonometric Functions
        • Inverse trigonometric functions
        • Hyperbolic Functions
        • Hyperbolic Inverses
        • Rounding functions
        • Exponential function
        • Logarithm functions
        • Minimum and maximum functions
        • Root functions
        • Factorial function
      • Forcing a one-way function
      • Troubleshooting
        • My calculator won’t save
        • Some variables are not calculated as I expected
    • Groups and variables
      • Groups
      • Variable attributes
        • Label
        • Suffix
        • Suffix end
        • Help text
        • Default value
        • Imperial def. value
        • Value select
        • Round to
          • Magic rounding
        • Advanced checkbox
        • Unit switcher
        • Works in reverse checkbox
        • Default unit
        • Imperial def. unit
        • Base unit
        • Default unit list
      • More variable attributes
        • Auto saved
        • Locked
        • Locked permanently
        • Don’t format
        • Field type
      • Copy attributes button
    • CustomJs
    • Value selects
      • How to define a value select
      • How to delete a value select
      • Value selects in CustomJs
    • Tests
      • How to create a test
      • Specifying values in different units
      • Taking a screenshot
      • Removing a test
    • Conditions
      • How to define a condition
      • Condition inequality operators
      • Specifying multiple conditions
      • Using math.js functions as condition tests
      • Using Omni.define functions as condition tests
  • Writing texts
    • Edit calculator text
      • Title and SEO title
        • Title
        • SEO title
      • Simple editor and syntax highlight editor
        • Markdown
          • Headings
          • Bold
          • Italic
          • Bold and italic
          • Blockquotes
          • Lists
          • Code
          • Horizontal rules
          • Links
          • Images
          • Escaping characters
          • HTML
        • Symbols
          • Copy and paste
          • Operating system character pickers
          • Emoji
        • Equations
          • Superscripts and subscripts
          • Centering short equations
          • Symbols
        • Links
          • Internal links — linking to other calculators
          • Markdown
        • Anchors
          • Calculator anchor
          • Creating named anchors
        • Pictures
          • How to upload pictures?
          • Free to use pictures resources
          • Stock photo account
          • How to attribute the author?
        • Tables
        • Videos
      • Description
      • FAQ
        • Adding an FAQ
        • Activating and deactivating FAQs
        • Changing the order of FAQs
        • Deleting an FAQ
        • Referencing an FAQ in the main text
        • Moving where the FAQ section appears
      • Revisions
      • SEO Check
        • Keywords
          • Adding a keyword
          • Deleting a keyword
        • Links
          • Adding a link
          • Adding the link code to the text
          • Deleting a link
        • Preview
        • Global SEO
          • Text min length
          • Bullet lists quantity
          • Bullet list keywords
          • Lead saturation
          • Keywords in headings
          • All images alt text
    • Calculator style guide
      • Title, slug, and equation
      • Variable name
      • Group headings
      • Help texts
      • Value selects
      • Conditions
    • Text styling guide
      • General notes
      • Text length
      • Capitalization
      • Section names
      • Lists
      • Equation and their variables
      • Tables
      • Internal links
      • External links
    • FAQ guide
      • What makes a good question?
        • Relatedness to Omni
        • Question’s first word
        • Topics to avoid
        • Question length
        • Don’t pick all of the most popular questions
        • Question summary
      • How to pick questions?
        • SEMrush
        • A note on calculator topics
        • Interesting questions
        • Question order
        • Checking questions on Google
        • Picking questions summary
      • Writing answers
        • Answer type
        • Word count
        • Structure
        • Bolding
        • Symbols, equations and units
        • Links
        • Emojis and images
        • A note on medical calculators
        • Answers summary
      • Writing integrated FAQ
        • Choosing keywords
        • Should all headings now be FAQs?
      • Examples
        • Does arc length have to be in radians?
        • What is the midpoint of 0 and 5?
        • How do you calculate basis points for commission?
        • How do I add a percentage increase to a number?
        • How do you find arc length without the radius?
        • How do you check your body fat?
        • How much does a car depreciate per year?
      • After publication
        • Checking results
        • FS
        • gFAQ
        • Rich results test
  • Keywords research
    • SEMrush
      • Keyword match
      • Related keywords
      • Filters
    • The most relevant keywords for Omni
    • Google Trends
  • Trello
    • Instruction
    • Reviewing procedure
      • Members
      • Labels
      • Date
      • Description
      • Checklist
      • Improving calculator after review
    • FAQ check
    • Links from previous calculators
    • Archiving cards
  • Slack
  • Grammarly
    • Browser extension
    • Text editor
  • Mastermind
    • How to use mastermind worksheet?
    • How to add an idea?
    • Ideas for marketing calculators
  • Monitoring the traffic
    • Google Analytics
      • Where did the traffic come from?
      • Opening Google Analytics for a calculator
      • Viewing the source/medium of page visits
      • Full source links
      • All pages report
        • Sessions and pages
        • All page views
        • Unique page views
        • Landing pages report
        • When to use each report
      • How is Omni doing in general?
      • How well are my calculators doing?
    • Google Search Console
      • How to open GSC for a calculator
      • The four stats of GSC
      • Keyword stats
      • Ideas for new calculators
  • Marketing calculators
    • How to participate?
      • What to expect when creating a marketing calculator
        • Build phase
        • Pitch phase
        • Response phase
    • Research document
      • Background
      • Idea
      • Target groups
      • Calculator ideas
      • Marketing campaigns
    • Calculator tips
    • Text tips
      • Making marketing graphics (simple guidelines)
  • Projects in Omni
    • Speedruns
    • Kick-ass
    • Omni-tube

Omni’s programming guide and documentation

All things programming at Omni

• Welcome to Omni’s customJS primer for Calculatorians©
  • Introduction:
    • A quick guide on customJS use cases
      • Why do we use customJS more and more
      • Should I use it?
        • CustomJS is uncalled for
        • CustomJS is desirable
        • CustomJS is compulsory
          • Presets
          • Weird formulas
          • Multiple personality disorder
        • Le Marketing (surrender your freedom for a greater good)
    • Programming, a very very brief overview
      • Programming vs Witchcraft, how to tell them apart
      • Javascript vs HTML
      • Basics of coding
        • Simple Variables
          • A word on variables in javascript
          • Booleans
            • Reference
          • Strings
            • Reference
          • Numbers
            • Reference
          • On operating across types
        • The basic loops and conditions
          • if … else
          • for
          • while
          • References
      • Basics of coding [advanced version]
        • Compounding variables like I have interest
          • Arrays
          • Functions
          • Objects
            • Dictionaries
            • Methods
        • Advanced version: A bunch of more words that might or might not mean stuff
          • do while
          • switch … case
          • break
          • for … in
          • for … of
          • labeled
          • continue
          • References
      • A programmer strives to be lazy (and you should, too)
        • The coding mindset
          • Don’t try to be a computer, play to your strengths
          • Your strengths, spend time doing this
          • Time learning vs time doing, what to do when
        • Lazy code vs sloppy code
  • Omni functions (technical):
    • Omni’s customJS technical documentation
      • Create a Value Select
        • Syntax
        • Arguments
          • data (Dictionary)
        • Example
      • Create a Value Setter
        • Syntax
        • Arguments
          • variableName
          • DATA
          • options
        • Example
      • Define custom calculator functions
        • Syntax
        • Arguments
          • name (string)
          • function
        • Example
      • On Initialization (context)
        • Syntax
        • Arguments
          • callback
        • Functions available inside omni.onInit context only
          • Bind a Value Select
            • Arguments
              • myValueSelect (value select)
              • variable (string)
              • Summary
          • Get country code
          • Set default value
            • Arguments
              • varName
              • value
              • units
                • Units in which value was defined. The string units must correspond with the slug of the units. If you are in doubt consult the Unit Switcher in the BB.
              • Summary
      • On Result (context)
        • Syntax
        • Arguments
          • callback
          • requiredVariables (array of strings)
            • Summary
        • Functions available only inside omni.onResult context
          • Hide Variables
            • Syntax
            • Arguments
              • variables
          • Show Variables
            • Syntax
            • Arguments
              • variables
          • Get Numerical Value(s) Variable(s)
            • Syntax
              • Arguments
          • Add images and styling (HTML)
            • Syntax
            • Arguments
              • Available options
          • Add text in the calculator
            • Syntax
            • Arguments
              • Available options
          • Add a Chart to the Calculator
            • Arguments
            • Colours of the datasets
            • Chart types and their peculiarities
              • Line Chart
              • Bar Chart
              • Area Chart
              • Pie Chart
          • Add custom conditions (Error Message)
            • Syntax:
            • Arguments
              • Text
          • Adding custom conditions that stop the calculator
          • Add a table with data
            • Arguments
              • Available options
          • Get Unit of a Variable
            • Syntax
              • Arguments
          • Get User’s Currency Symbol
            • Syntax
          • Get Label (displayed name)
            • Syntax
            • Arguments
              • myVar (string)
          • Check if imperial units are default
            • Syntax
          • Check if calculator is embedded
            • Arguments
              • platform (“embed”)
          • Get Displayed Value
            • Syntax
              • Arguments
          • Get Value(s)
            • Syntax
              • Arguments
          • Get Raw user input
            • Syntax
            • Arguments
              • varName
      • Introduction
  • Practical help and examples
    • Standard usage of customJS
      • Basics
        • Custom Message in Calculator
          • Static messages
          • Dynamic messages
        • Dynamic Show show/hide variables
        • How to create a line chart
          • Practical example
          • Code and comments
        • How to create an area chart
          • Practical example
          • Code and comments
        • How to create a bar chart
          • Practical example
          • Code and comments
        • How to create a pie Chart
          • Practical example
          • Code and comments
        • How to insert an image in the calculator
          • Code and example (Image anywhere)
          • Code and example (Image on top)
          • Useful Html attributes for images
        • Dynamic table under calculator
        • Custom Error Messages
      • Advanced
        • Requirements on Variables (Int only input)
        • Formatting numbers
          • Rounding
            • Rounding (output=> number)
            • Formatting (output =>string)
          • Padding
          • Dot/Comma formatting
        • Magic Rows (Advanced show/hide)
          • Practical example
          • There is a version for you
            • Average (Mateusz’s example)
            • BAC (Marysia )
        • Dynamic Images in Calculators
          • Array method
          • If-else Method
          • Name Method
        • Graphs and charts (Extra)
          • Limit data size (Avoid computational slow-downs)
          • A word on user defined chart type
          • Custom labels (x-axis)
          • Red for negative values
        • Stack a.k.a. playing Jenga in customJS
          • Expected use case or how to make it work
          • Data stacked with contrasting colours (Doesn’t work)
          • The workaround that works (around)
          • An open playground (Jenga provided)
      • Value Setter/Select
        • Creating a value Select/Setter (Basics)
          • Creating a value select
          • Creating a value setter
          • Setting default values for value Select/Setter
        • Adding custom option to Value Setter (user input)
        • Dynamically changing vSetters on runtime
        • Nesting Value Setters
    • From Calculatorian to Calculatorian (tips and tricks)
      • Problem solving
        • Standard debugging procedure (step by step)
          • Basic approach: the power of ctx
          • The calculator disappeared (console.log the sh** out of your code)
          • The ace up your sleeve (temporary delete code)
          • When all hope is lost (summoning the oracle)
          • A word on prevention
        • How to ask for help
          • Before you ask for help
          • How to ask the best question
          • The perfect question
        • How to save a changes after a calculator crash
        • The life cycle of a variable
          • Scope of a variable
          • Scope and loops
          • Global variables to pass information between contexts and context executions
        • When is what executed?
          • Blocks of code
          • Loading the calculator
          • Using the calculator
            • Special cases
          • tl;dr
        • Getting values of variables
          • Get number value using ctx
          • Using toNumber(): when and why
        • Comparisons, staying sane a little longer
          • The basics, when a plan comes together
          • Truthy, flasy and why 0 and ‘0’ are kinda the same but not really
          • When ‘equals’ are not enough, how NaN is not the same as NaN
        • Practical Problem Solving: Equations
      • Tips and tricks
        • The template: a starting point for your cJS adventure
          • What is in the template
            • Parts of the calculator
          • How to use the template
            • tl;dr
        • Repository and usage
          • How to use it
          • How to contribute to the repo
          • The functions
            • Charts and Arrays
              • Change color of a chart from an arbitrary point
                • The functions and its parameters
            • Miscellaneous
            • Playing with time
              • Convert Seconds to formatted time
                • The functions and its parameters
            • Symbolic library
            • Value Selects and Value Setters
        • Dating by yourself (or how to play with time in customJS)
          • Dates in javascript (Date class)
          • Dates in Omni Calculators
          • Useful tricks to format time
            • Global variables
            • Reusing someone else’s work
          • tl;dr
        • Better conditions in your code
          • Conditions without comparison (Boolean conversion)
          • Ternary operator (ifs without ifs)
          • Stealthy conditions (Implicit conditions to avoid errors)
        • Changing Value Setters on runtime
          • Clear field for custom option
          • Nesting with default values
        • Equation editor - Part 1
          • The basics
          • Custom functions
        • Equation editor - Part 2
          • Ensuring multi-directional solutions: Systems of equations
          • [Trick/Hack] Defining two-way custom function
        • How to test your calculators
          • Simple calculators
          • One step beyond: The madness of complex calculators
          • Complications and how to avoid them
      • General advice and guidelines
        • Naming Variables: a proposal for a common standard
          • General rules for names in any program
          • Calculator Variables
          • Variables in customJS
          • Value Setters/Selects and other data
          • A word on authoritarianism
        • How to deal with images
          • Let’s not get sued, shall we?
          • The obesity pandemic, img edition
          • Don’t make the rules fit the image, make the imagine fit the rules
          • How to store your images
            • A guide on storing files in our FTP server
  • Extra resources
    • Repository and usage
      • How to use it
      • How to contribute to the repo
      • The functions
        • Charts and Arrays
          • Change color of a chart from an arbitrary point
            • The functions and its parameters
        • Miscellaneous
        • Playing with time
          • Convert Seconds to formatted time
            • The functions and its parameters
        • Symbolic library
        • Value Selects and Value Setters
    • About this Documentation
      • Authors