Overview

Smart.Tank represents a numeric control used to display a numeric value from a range of values.

Files

  • CSS files
    • smart.default.css - the CSS file containing the styles for the element.
  • Javascript module
    • smart.tank.js - the JS module which is in the source/modules/ folder and loads all script dependencies.
  • Javascript files
    • smart.element.js - the base class.
    • smart.numeric.js - this file contains functions used for the processing of numeric objects.
    • smart.math.js - the JS file containing containing many of the mathematical functions used by element.
    • smart.tickintervalhandler.js - the JS file containing functions used for calculating the tick interval of the element.
    • smart.tank.js - the JS file containing the definition for the element.

Usage

  • Import a module

    With this approach, we import a module and create the web component by using the Smart function. The #tank is a smart-tank tag.

    import {smartTank} from "../../../source/modules/smart.tank.js";
    
    Smart('#tank', class {
    get properties() {
    	return {
    		orientation: 'horizontal'
    	}
    }
    });
    
    document.readyState === 'complete' ? init() : window.onload = init;
    
    function init() { 
    
    }
    
    Using the Smart function is optional. You can use const tank = document.querySelector("#tank"); and set the properties like that:
    const tank = document.querySelector("#tank");
    
    tank.orientation = 'horizontal';
    

  • Import a module, Init on Demand

    The following imports the web component's module and creates it on demand, when the document is ready. The #tank is a DIV tag.

    import {smartTank} from "../../../source/modules/smart.tank.js";
    
    document.readyState === 'complete' ? init() : window.onload = init;
    
    function init() { 
    const tank = new smartTank('#tank', {
       	orientation: 'horizontal'
    });
    }
    
  • Load scripts

    The following code adds the custom element to the page.

    <!DOCTYPE html>
    <html lang="en">
    <head>
     <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
     <script type="text/javascript" src="../../source/smart.element.js"></script>
     <script type="text/javascript" src="../../source/smart.numeric.js"></script>
     <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
     <script type="text/javascript" src="../../source/smart.math.js"></script>
     <script type="text/javascript" src="../../source/smart.tank.js"></script>
    </head>
    <body>
     <smart-tank></smart-tank>
    </body>
    </html>
    

    Note how smart.element.js is declared before everything else. This is mandatory for all custom elements.

Demo

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event


Create a new element:
const tank = document.createElement('smart-tank');

Append it to the DOM:
document.body.appendChild(tank);

Remove it from the DOM:
tank.parentNode.removeChild(tank);

Set a property:
tank.propertyName = propertyValue;

Get a property value:
const propertyValue = tank.propertyName;

Invoke a method:
tank.methodName(argument1, argument2);

Add Event Listener:
const eventHandler = (event) => {
// your code here.
};

tank.addEventListener(eventName, eventHandler);

Remove Event Listener:
tank.removeEventListener(eventName, eventHandler, true);

Appearance

Smart.Tank can be either horizontal or vertical. The default orientation is vertical but that can be changed on initialization in the HTML:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
</head>
<body>
 <smart-tank orientation="horizontal"></smart-tank>
</body>
</html>

Demo

or later using javascript:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
 <script>
     window.onload = function () {
         var tank = document.querySelector('smart-tank');
         tank.orientation = 'horizontal';
     }
 </script>
</head>
<body>
 <smart-tank></smart-tank>
</body>
</html>

Demo


Smart.Tank uses a scale to indicate the value. The scale can be positioned above, under or on both sides of the element thanks to the scalePosition property. By default it's located over the element for horizontal tank or before the element for vertical tank.

Let's change the position of the scale via javascript:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
 <script>
     window.onload = function () {
         var tank = document.querySelector('smart-tank');
         tank.scalePosition = 'both';
     }
 </script>
</head>
<body>
 <smart-tank></smart-tank>
</body>
</html>

Demo


The ticks of the scale can also be customized. They can be positioned above the track or inside it by setting the tickPosition property like so:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
 <script>
     window.onload = function () {
         var tank = document.querySelector('smart-tank');
         tank.ticksPosition = 'track';
     }
 </script>
</head>
<body>
 <smart-tank></smart-tank>
</body>
</html>

Demo


The scale of the Tank contains major and minor ticks which are by default visible. This can be re-configured. The user can display only the major, the minor or none of them if he prefers by setting the ticksVisibility property. This can also be done in the HTML code on initialization like so:

<smart-tank ticks-visibility="major"></smart-tank>

Demo

The scale of the Tank has ticks and labels. Labels are also customizable. The user can control which of them to be visible:

  • none - no labels are visible
  • all - all labels are visible
  • endPoints - only the first and last labels are visible

The text of the label can also be modified thanks to the labelFormatFunction property. It's a format function that takes one argument - the value of the label. The function must return a string representing the new text for the lables. The property can be applied via javascript like so:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
 <script>
     window.onload = function () {
             var tank = document.querySelector('smart-tank');
             tank.labelFormatFunction = function (value) {
             return value + ' ' + 'gal';
         }
     }
 </script>
</head>
<body>
 <smart-tank></smart-tank>
</body>
</html>

Demo

Behavior

Smart.Tank allows two types of scales:

  • integer - the values are integers only
  • floatingPoint - the values are floating point numbers

The type of the scale is determined by the scaleType property which can be set on initialization:

<smart-tank scale-type="integer"></smart-tank>

Demo

or changed later when the element is ready using javascript:

<script>
     window.onload = function () {
         var tank = document.querySelector('smart-tank');
         tank.scaleType = 'floatingPoint';
     }
 </script>

Demo

When the scaleType is set to "floatingPoing", the user can adjust the precision of the value via the "precisionDigits" property. This property determines how many numbers will appear after the decimal point of the current Tank value. Can be set like every other property:

<smart-tank precision-digits="2"></smart-tank>

Demo

Smart.Tank allows controlling the number significant digits shown on the scale. The significantDigits property determines how will the value be represented. For example, let's say the user wants to configure the value to contain only 3 significant digits:

<smart-tank max="1000000" significant-digits="3"></smart-tank>

Note: significantDigits and precisionDigits can't be applied at the same time.


Smart.Tank supports big numbers as well. The wordLength property determines the range of numbers the element can display.

The available word lengths are:

  • int8 : from –128 to 127
  • uint8 : from 0 to 255
  • int16 : from –32,768 to 32,767
  • uint16 : from 0 to 65,535
  • int32 : from –2,147,483,648 to 2,147,483,647. Default value.
  • uint32 : from 0 to 4,294,967,295
  • int64 : from –9,223,372,036,854,775,808 to 9,223,372,036,854,775,807
  • uint64 : from 0 to 18,446,744,073,709,551,615

Here's how to set it as attribute:

<smart-tank word-length="uint8"></smart-tank>

The mechanicalAction property of the element determines when the value will change. This property determines the behavior of the element. Possible values are:

  • switchUntilReleased - changes the value while the user is dragging inside the track. When the mouse is released the value is returned to it's initial position.
  • switchWhenReleased - changes the value only when the mouse is released. Otherwise the value remains static.
  • switchWhileDragging - changes the value while the user is dragging along the track and keeps the last value when mouse is released. The default value.
<smart-tank mechanical-action="switchWhenReleased"></smart-tank>

Demo

Coerce property determines the value interation. Once enabled the element uses the interval property to determines the next possible selectable value from the scale.

By setting the interval property the user can control the interval between the values. Interval is a property of type number and can be set on initialization or using javascript:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
 <script>
     window.onload = function () {
         var tank = document.querySelector('smart-tank');
         tank.interval = 10;
         tank.coerce = true;
     }
 </script>
</head>
<body>
 <smart-tank></smart-tank>
</body>
</html>

Demo

If coerce is enabled the track fill will snap to the next value based on the interval.

Keyboard Support

Smart.Tank implements the following keys:

Key Action
Arrow Up / Arrow Right Increases the value.
Arrow Left / Arrow Down Decreases the value.
Home Sets the value to min.
End Sets the value to max.

Styling

Styling Smart.Tank is done using normal CSS selectors and variables. Every stylable component of the element has a class name that can be targeted using the dot (".") selector following the class name:

Smart.Tank uses the following CSS variables for styling:

  • --smart-tank-default-width - the default width of Smart.Tank/Smart.Slider.
  • --smart-tank-default-height - the default height of Smart.Tank/Smart.Slider.
  • --smart-tank-scale-size - Vertical Tank's scale width / Horizontal Tank's scale height.
  • --smart-tank-thumb-width - thumbs width.
  • --smart-tank-thumb-height - thumbs height.
  • --smart-tank-tooltip-width - tooltip width.
  • --smart-tank-tooltip-height - tooltip height.
  • --smart-tank-tick-size - scale's major ticks size. Horizontal Tank tick height / Vertical Tank tick width.
  • --smart-tank-minor-tick-size - scale's minor ticks size.
  • --smart-tank-minimum-track-size - Horizontal Tank track minimum height / Vertical Tank track minimum width.

Here's how to apply the variables:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.numeric.js"></script>
 <script type="text/javascript" src="../../source/smart.math.js"></script>
 <script type="text/javascript" src="../../source/smart.tickintervalhandler.js"></script>
 <script type="text/javascript" src="../../source/smart.tank.js"></script>
 <style>
     smart-tank {
         --smart-tank-tick-size: 20px;
         --smart-tank-minor-tick-size: 10px;
     }
 </style>
</head>
<body>
 <smart-tank></smart-tank>
</body>
</html>