Movatterモバイル変換

[0]ホーム
URL:

newupdatedpro

  • Overview

  • Framework and Utilities

  • Angular

  • React

  • Vue

  • Blazor

  • Integrations

  • Roadmap

  • Release Notes

  • Accessibility

  • Theme Builder

  • Complex Components

  • Grid

  • Gantt Chart

  • Scheduler

  • CardView

  • Chart

  • Editor

  • DockingLayout

  • Kanban

  • PivotTable

  • Table

  • Core Components

  • Accordion

  • Badge

  • Barcode

  • Button

  • Breadcrumb

  • Card

  • Carousel

  • Calendar

  • CheckBox

  • ComboBox

  • ColorPicker

  • DateTimePicker

  • DropDownList

  • DropDownButton

  • FileUpload

  • Form

  • Gauge

  • Input

  • ListBox

  • ListMenu

  • Layout

  • MaskedTextBox

  • Menu

  • MultilineTextBox

  • MultiSplitButton

  • NumericTextBox

  • Pager

  • PasswordTextBox

  • PowerButton

  • ProgressBar

  • QueryBuilder

  • RadioButton

  • Rating

  • RepeatButton

  • Ribbon Bar

  • Qrcode

  • ScrollBar

  • Slider

  • Splitter

  • SwitchButton

  • Sortable

  • Tabs

  • Tank

  • TextBox

  • TimePicker

  • Toast

  • ToggleButton

  • Tooltip

  • Tree

  • Window

Tank JAVASCRIPT UI Component API

Tank Javascript API

Class

Tank

Tank

Tank is a UI Component used in Engineering and Scientific applications. It is broadly used to display the fluid levels.

Selector

smart-tank

Properties

AanimationControls the animation mode by setting or retrieving its current state. When set to 'none', all animations are disabled and transitions will not occur. Use this property to enable, disable, or modify animation behavior according to your application's requirements.
CcoerceWhen set to true, all values will be automatically adjusted (coerced) to fit within the range specified by the interval property. This ensures that any value outside the defined interval is converted to the nearest valid value within that range.
CcustomIntervalControls whether custom tick marks, which may be spaced at uneven intervals, are displayed on the axis. The specific positions of these ticks are specified using the customTicks property. This option can be used to enable or disable the rendering of these custom-defined ticks.
CcustomTicksIf customInterval is enabled, this option provides a specific list of tick values to display on the plot's axis, overriding any automatically calculated intervals. When coerce is set to true, user inputs or plotted values will automatically adjust (or "snap") to the nearest tick in this list, ensuring all values align precisely with one of the specified ticks.Click for more details. Property object's options:
    DdateLabelFormatStringSpecifies or retrieves the pattern used to format labels when the mode property is set to 'date'. This pattern determines how date labels are displayed to the user (for example, "MM/DD/YYYY" or "dd MMM, yyyy").
    DdecimalSeparatorSpecifies or retrieves the character used as the decimal separator in numeric values. This determines how decimal points are displayed when formatting or parsing numbers (e.g., use "." for 12.34 or "," for 12,34, depending on locale or formatting requirements).
    DdisabledDetermines whether the widget is active and visible to users. When enabled, the widget functions normally and is displayed in the user interface; when disabled, the widget is hidden or inactive, preventing user interaction.
    IintervalWhen the 'coerce' property is set to 'true', any input values that fall outside the specified interval will be automatically adjusted ("coerced") to the nearest boundary value of the interval. This ensures that all resulting values strictly adhere to the defined range, preventing any out-of-bounds input.
    IinvertedDefines the orientation of the tank. When set to true, the positions of the tank's front and rear are swapped, effectively reversing its direction.
    LlabelFormatFunctionA user-defined callback function that formats the values shown on the tank labels before they are displayed. This function receives the raw value as an argument and should return the formatted string to be rendered on the label, allowing for custom display logic such as unit conversion, number formatting, or localization.
    LlabelsVisibilityControls the visibility of the widget's label. When set, this property determines whether the label is displayed or hidden. When retrieved, it indicates the current visibility state of the label.
    UunlockKeyRetrieves or assigns the unlockKey property, which serves as a security token or code required to activate and access the product's full functionality.
    LlocaleSpecifies the current locale for the application. This property determines language and regional formatting, and works together with the messages property to provide appropriate translations and locale-specific content. Use this property to get or set the active locale for displaying messages and other localized resources.
    LlocalizeFormatFunctionCallback function associated with the localization module. This callback is triggered during localization operations, such as language selection, translation processing, or locale updates, to handle custom logic or respond to localization events within the application.
    LlogarithmicScaleDetermines whether the widget displays data using a logarithmic scale. When enabled, values are plotted on a logarithmic scale instead of a linear scale, which can help visualize data with a wide range of values. When disabled, the widget uses a standard linear scale.
    MmaxGets or sets the maximum allowable value for the widget, defining the upper limit that users can select or enter.
    MmechanicalActionDefines or retrieves the specific type of mechanical action being applied. This property allows you to specify what kind of mechanical action to use (such as momentary, toggle, or latching), or to query the current mechanical action configuration.
    MmessagesDefines or retrieves an object containing the localizable text strings used throughout the widget interface. This property allows you to customize the widget’s displayed messages for different languages and regions. It is typically used together with the locale property to support internationalization and provide translations based on the user’s locale settings.
    MminDefines or retrieves the minimum allowable value for the widget. When setting this property, it restricts user input so that values below the specified minimum are not permitted. When getting this property, it returns the current minimum value constraint of the widget.
    MmodeDetermines whether the widget processes and displays numeric values or date values. This property can be set to configure the expected data type (numbers or dates), and can also be accessed to check the current mode of the widget.
    NnameDefines or retrieves the element's name attribute. This name uniquely identifies the element within a form and is used as the key when the form data is submitted to the server, allowing the associated value to be referenced and processed.
    OorientationSpecifies the layout direction of the widget, determining whether its content is arranged horizontally, vertically, or in another supported orientation.
    PprecisionDigitsSpecifies the number of digits to display after the decimal point in numeric values. This setting is only applicable when scaleType is set to 'integer'.
    RreadonlyIf the widget is set to read-only, users will not be able to interact with or modify the element's content. Any input or actions from users will be disabled, ensuring that the widget's state remains unchanged.
    RrightToLeftGets or sets a value that specifies whether the element’s content is aligned to accommodate right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element’s alignment and text direction are adjusted for proper display in RTL locales.
    SscalePositionSpecifies the placement of the widget’s scales relative to its main content, determining where the scale markers or labels appear within the widget interface (e.g., top, bottom, left, or right).
    SscaleTypeSpecifies the measurement system used for the tank's scale, such as linear, logarithmic, or custom, which determines how values are displayed and interpreted on the tank's indicator.
    SscientificNotationDetermines whether numerical values are displayed using scientific notation (e.g., 1.23e+6 instead of 1230000). Set to true to enable scientific notation, or false to display numbers in standard decimal format.
    SshowThumbLabelControls whether the thumb label is visible or hidden. When enabled, the thumb label will be displayed alongside the slider's handle, providing users with a visual indicator of the current value. When disabled, the thumb label will not appear.
    SshowTooltipControls whether the tooltip is visible to the user. When enabled, the tooltip will be displayed; when disabled, the tooltip will be hidden.
    SshowUnitControls whether unit labels (such as "kg", "cm", "°C") are shown alongside values. Set to true to display units next to values, or false to hide them.
    SsignificantDigitsCalculates the number of significant digits present in a given number. This process is only relevant and performed when the scaleType property is set to 'integer'. This property should be used to ensure numerical data integrity and appropriate formatting for integer-based values.
    TthemeSets or retrieves the visual theme applied to the element, determining its overall appearance such as color scheme, typography, and style variants. This property allows dynamic customization of the element’s look to match different design requirements or user preferences.
    TthumbLabelPositionSets or retrieves the current position of the thumb label, typically representing the value indicator on a slider or range input. This property allows you to programmatically control or access the exact location of the label relative to the slider track.
    TticksPositionDefines or retrieves the placement of the tick marks in the smartTank widget, specifying where the ticks are displayed relative to the tank (e.g., near, far, or both sides). This property allows you to control the visual positioning of the tick indicators along the scale of the smartTank widget.
    TticksVisibilityControls whether the ticks are visible or hidden. This property allows you to enable (show) or disable (hide) the display of tick marks on the relevant component. When set, it determines if ticks are rendered; when accessed, it returns the current visibility state of the ticks.
    TtooltipPositionSpecifies or retrieves the position of the tooltip displayed on the smartTank widget. This property determines where the tooltip appears relative to the tank control (e.g., top, bottom, left, or right). Use this option to customize the tooltip's placement for improved user experience and interface alignment.
    UunfocusableDetermines whether the element is focusable by setting or retrieving its ability to receive keyboard or mouse focus. If set to true, the element can be targeted by user interactions such as tab navigation or clicking.
    UunitSpecifies or retrieves the unit label displayed on the smartTank widget, indicating the measurement unit (e.g., "°C", "kg", "psi") associated with the tank's value. This property allows you to customize the text that appears alongside the value in the widget for better context and readability.
    VvalidationEnhances value validation using minimum and maximum boundaries. - When set to 'strict', all values—whether changed by user interaction or programmatically—are always constrained within the definedmin andmax limits. Any attempt to set a value outside this range will automatically adjust (coerce) it to the closest valid boundary.- When set to 'interaction', only values changed by user interaction (such as form input) are validated againstmin andmax. Programmatic updates can set values outside this range, and if themin ormax properties are later adjusted such that the current value falls out of bounds, the existing value remains unchanged and is not coerced. In these cases, no change event is triggered.
    VvalueGets the current value of the smartTank widget or sets it to a specified value. This property or method enables you to retrieve the widget's current position (value) or assign a new value programmatically, allowing for dynamic interaction and control over the smartTank component.
    WwordLengthSpecifies or retrieves the word length used for numeric representation. This property is relevant only when the scaleType is set to 'integer'. In such cases, it determines the number of bits allocated for each integer value. For other scaleType values, this setting has no effect.

    Events

    CchangeThis event is triggered whenever the tank’s value is updated, whether through user interaction or programmatic changes. It allows listeners to respond immediately to any modification in the tank’s current state.

    Methods

    FfocusLocks the keyboard and mouse input exclusively on the tank component, ensuring that all user interactions are directed to the tank (such as movement and firing controls) while disabling interactions with other interface elements.
    GgetOptimalSizeRetrieves the recommended dimensions (width and height) for the widget based on its content and layout constraints, ensuring optimal display and usability.
    VvalRetrieves or updates the current value stored in the tank. Use this property to access the tank’s value (such as its level, volume, or contents) or to assign a new value to it.

    Properties

    animation"none" | "simple" | "advanced"

    Controls the animation mode by setting or retrieving its current state. When set to'none', all animations are disabled and transitions will not occur. Use this property to enable, disable, or modify animation behavior according to your application's requirements.

    Allowed Values

    • "none" - animation is disabled
    • "simple" - ripple animation is disabled
    • "advanced" - all animations are enabled

    Default value

    "advanced"

    Example

    Set theanimation property.

     <smart-tank animation='none'></smart-tank>

    Set theanimation property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.animation = 'simple';

    Get theanimation property.

     const tank = document.querySelector('smart-tank');
     let animation = tank.animation;

    coerceboolean

    When set to true, all values will be automatically adjusted (coerced) to fit within the range specified by the interval property. This ensures that any value outside the defined interval is converted to the nearest valid value within that range.

    Default value

    false

    Example

    Set thecoerce property.

     <smart-tank coerce></smart-tank>

    Set thecoerce property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.coerce = false;

    Get thecoerce property.

     const tank = document.querySelector('smart-tank');
     let coerce = tank.coerce;

    customIntervalboolean

    Controls whether custom tick marks, which may be spaced at uneven intervals, are displayed on the axis. The specific positions of these ticks are specified using thecustomTicks property. This option can be used to enable or disable the rendering of these custom-defined ticks.

    Default value

    false

    Example

    Set thecustomInterval property.

     <smart-tank custom-interval></smart-tank>

    Set thecustomInterval property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.customInterval = false;

    Get thecustomInterval property.

     const tank = document.querySelector('smart-tank');
     let customInterval = tank.customInterval;

    customTicksnumber[]

    IfcustomInterval is enabled, this option provides a specific list of tick values to display on the plot's axis, overriding any automatically calculated intervals. Whencoerce is set totrue, user inputs or plotted values will automatically adjust (or "snap") to the nearest tick in this list, ensuring all values align precisely with one of the specified ticks.

    Example

    Set thecustomTicks property.

     <smart-tank custom-ticks='[100, 200, 1000, 8000, 10000]'></smart-tank>

    Set thecustomTicks property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.customTicks = [1, 3, 5, 8];

    Get thecustomTicks property.

     const tank = document.querySelector('smart-tank');
     let customTicks = tank.customTicks;

    dateLabelFormatStringstring

    Specifies or retrieves the pattern used to format labels when themode property is set to'date'. This pattern determines how date labels are displayed to the user (for example, "MM/DD/YYYY" or "dd MMM, yyyy").

    Default value

    "d"

    Example

    Set thedateLabelFormatString property.

     <smart-tank date-label-format-string='dddd-MMMM-yyyy'></smart-tank>

    Set thedateLabelFormatString property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.dateLabelFormatString = 'FP';

    Get thedateLabelFormatString property.

     const tank = document.querySelector('smart-tank');
     let dateLabelFormatString = tank.dateLabelFormatString;

    decimalSeparatorstring

    Specifies or retrieves the character used as the decimal separator in numeric values. This determines how decimal points are displayed when formatting or parsing numbers (e.g., use "." for 12.34 or "," for 12,34, depending on locale or formatting requirements).

    Default value

    "".""

    Example

    Set thedecimalSeparator property.

     <smart-tank decimal-separator=','></smart-tank>

    Set thedecimalSeparator property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.decimalSeparator = '.';

    Get thedecimalSeparator property.

     const tank = document.querySelector('smart-tank');
     let decimalSeparator = tank.decimalSeparator;

    disabledboolean

    Determines whether the widget is active and visible to users. When enabled, the widget functions normally and is displayed in the user interface; when disabled, the widget is hidden or inactive, preventing user interaction.

    Default value

    false

    Example

    Set thedisabled property.

     <smart-tank disabled></smart-tank>

    Set thedisabled property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.disabled = false;

    Get thedisabled property.

     const tank = document.querySelector('smart-tank');
     let disabled = tank.disabled;

    intervalstring | number

    When the 'coerce' property is set to 'true', any input values that fall outside the specified interval will be automatically adjusted ("coerced") to the nearest boundary value of the interval. This ensures that all resulting values strictly adhere to the defined range, preventing any out-of-bounds input.

    Default value

    1

    Example

    Set theinterval property.

     <smart-tank interval='2'></smart-tank>

    Set theinterval property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.interval = 10;

    Get theinterval property.

     const tank = document.querySelector('smart-tank');
     let interval = tank.interval;

    invertedboolean

    Defines the orientation of the tank. When set to true, the positions of the tank's front and rear are swapped, effectively reversing its direction.

    Default value

    false

    Example

    Set theinverted property.

     <smart-tank inverted></smart-tank>

    Set theinverted property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.inverted = false;

    Get theinverted property.

     const tank = document.querySelector('smart-tank');
     let inverted = tank.inverted;

    labelFormatFunctionfunction | null

    A user-defined callback function that formats the values shown on the tank labels before they are displayed. This function receives the raw value as an argument and should return the formatted string to be rendered on the label, allowing for custom display logic such as unit conversion, number formatting, or localization.

    Example

    Set thelabelFormatFunction property.

     <smart-tank label-format-function='function (value) { return value + '%'; }'></smart-tank>

    Set thelabelFormatFunction property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.labelFormatFunction = function (value) { return value + '$'; };

    Get thelabelFormatFunction property.

     const tank = document.querySelector('smart-tank');
     let labelFormatFunction = tank.labelFormatFunction;

    labelsVisibility"all" | "endPoints" | "none"

    Controls the visibility of the widget's label. When set, this property determines whether the label is displayed or hidden. When retrieved, it indicates the current visibility state of the label.

    Default value

    "all"

    Example

    Set thelabelsVisibility property.

     <smart-tank labels-visibility='endPoints'></smart-tank>

    Set thelabelsVisibility property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.labelsVisibility = 'none';

    Get thelabelsVisibility property.

     const tank = document.querySelector('smart-tank');
     let labelsVisibility = tank.labelsVisibility;

    unlockKeystring

    Retrieves or assigns the unlockKey property, which serves as a security token or code required to activate and access the product's full functionality.

    Default value

    ""

    Example

    Set theunlockKey property.

     <smart-tank unlock-key=''></smart-tank>

    Set theunlockKey property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.unlockKey = '1111-2222-3333-4444-5555';

    Get theunlockKey property.

     const tank = document.querySelector('smart-tank');
     let unlockKey = tank.unlockKey;

    localestring

    Specifies the current locale for the application. This property determines language and regional formatting, and works together with themessages property to provide appropriate translations and locale-specific content. Use this property to get or set the active locale for displaying messages and other localized resources.

    Default value

    "en"

    Example

    Set thelocale property.

     <smart-tank locale='de'></smart-tank>

    Set thelocale property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.locale = 'fr';

    Get thelocale property.

     const tank = document.querySelector('smart-tank');
     let locale = tank.locale;

    localizeFormatFunctionfunction | null

    Callback function associated with the localization module. This callback is triggered during localization operations, such as language selection, translation processing, or locale updates, to handle custom logic or respond to localization events within the application.

    Example

    Set thelocalizeFormatFunction property.

     <smart-tank localize-format-function='function(){return '...'}'></smart-tank>

    Set thelocalizeFormatFunction property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.localizeFormatFunction = function(){return '...'};

    Get thelocalizeFormatFunction property.

     const tank = document.querySelector('smart-tank');
     let localizeFormatFunction = tank.localizeFormatFunction;

    logarithmicScaleboolean

    Determines whether the widget displays data using a logarithmic scale. When enabled, values are plotted on a logarithmic scale instead of a linear scale, which can help visualize data with a wide range of values. When disabled, the widget uses a standard linear scale.

    Default value

    false

    Example

    Set thelogarithmicScale property.

     <smart-tank logarithmic-scale></smart-tank>

    Set thelogarithmicScale property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.logarithmicScale = false;

    Get thelogarithmicScale property.

     const tank = document.querySelector('smart-tank');
     let logarithmicScale = tank.logarithmicScale;

    maxstring | number

    Gets or sets the maximum allowable value for the widget, defining the upper limit that users can select or enter.

    Default value

    100

    Example

    Set themax property.

     <smart-tank max='20'></smart-tank>

    Set themax property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.max = 50;

    Get themax property.

     const tank = document.querySelector('smart-tank');
     let max = tank.max;

    mechanicalAction"switchUntilReleased" | "switchWhenReleased" | "switchWhileDragging"

    Defines or retrieves the specific type of mechanical action being applied. This property allows you to specify what kind of mechanical action to use (such as momentary, toggle, or latching), or to query the current mechanical action configuration.

    Default value

    "switchWhileDragging"

    Example

    Set themechanicalAction property.

     <smart-tank mechanical-action='switchWhenReleased'></smart-tank>

    Set themechanicalAction property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.mechanicalAction = 'switchUntilReleased';

    Get themechanicalAction property.

     const tank = document.querySelector('smart-tank');
     let mechanicalAction = tank.mechanicalAction;

    messagesobject

    Defines or retrieves an object containing the localizable text strings used throughout the widget interface. This property allows you to customize the widget’s displayed messages for different languages and regions. It is typically used together with thelocale property to support internationalization and provide translations based on the user’s locale settings.

    Default value




    "en": {

    "propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

    "propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

    "propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

    "elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

    "moduleUndefined": "Module is undefined.",

    "missingReference": "{{elementType}}: Missing reference to {{files}}.",

    "htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

    "invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",

    "significantPrecisionDigits": "{{elementType}}: the properties significantDigits and precisionDigits cannot be set at the same time.",

    "invalidMinOrMax": "{{elementType}}: Invalid {{property}} value. Max cannot be lower than Min.",

    "noInteger": "{{elementType}}: precisionDigits could be set only on \"floatingPoint\" scaleType."

    }

    Example

    Set themessages property.

     <smart-tank messages='{"de":{"propertyUnknownType":"Die Eigenschaft '{{name}}' hat ein nicht definiertes 'type'-Member!","propertyInvalidValue":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualValue}}, Erwarteter Wert: {{value}}!","propertyInvalidValueType":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualType}}, Erwarteter Wert: {{type}}!","elementNotInDOM":"Element existiert nicht in DOM! Bitte fugen Sie das Element zum DOM hinzu, bevor Sie eine Methode aufrufen.","moduleUndefined":"Modul ist nicht definiert.","missingReference":"{{elementType}}: Fehlender Verweis auf {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser unterstutzt keine HTMLTemplate-Elemente.","invalidTemplate":"{{elementType}}: '{{property}}' Die Eigenschaft akzeptiert eine Zeichenfolge, die mit der ID eines HTMLTemplate-Elements aus dem DOM ubereinstimmen muss.","significantPrecisionDigits":"{{elementType}}: Die Eigenschaften significantDigits und precisionDigits konnen nicht gleichzeitig eingestellt werden.","invalidMinOrMax":"{{elementType}}: Ungultiger Wert {{property}} Max kann nicht niedriger sein als Min.","noInteger":"{{elementType}}: precisionDigits konnte nur fur \"floatingPoint\" scaleType festgelegt werden."}}'></smart-tank>

    Set themessages property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.messages = {"en":{"propertyUnknownType":"'{{name}}' property is with undefined 'type' member!","propertyInvalidValue":"Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!","propertyInvalidValueType":"Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!","elementNotInDOM":"Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.","moduleUndefined":"Module is undefined.","missingReference":"{{elementType}}: Missing reference to {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser doesn't support HTMLTemplate elements.","invalidTemplate":"{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.","significantPrecisionDigits":"{{elementType}}: the properties significantDigits and precisionDigits cannot be set at the same time.","invalidMinOrMax":"{{elementType}}: Invalid {{property}} value. Max cannot be lower than Min.","noInteger":"{{elementType}}: precisionDigits could be set only on \"floatingPoint\" scaleType."}};

    Get themessages property.

     const tank = document.querySelector('smart-tank');
     let messages = tank.messages;

    minstring | number

    Defines or retrieves the minimum allowable value for the widget. When setting this property, it restricts user input so that values below the specified minimum are not permitted. When getting this property, it returns the current minimum value constraint of the widget.

    Default value

    0

    Example

    Set themin property.

     <smart-tank min='20'></smart-tank>

    Set themin property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.min = 50;

    Get themin property.

     const tank = document.querySelector('smart-tank');
     let min = tank.min;

    mode"numeric" | "date"

    Determines whether the widget processes and displays numeric values or date values. This property can be set to configure the expected data type (numbers or dates), and can also be accessed to check the current mode of the widget.

    Default value

    "numeric"

    Example

    Set themode property.

     <smart-tank mode='date'></smart-tank>

    Set themode property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.mode = 'numeric';

    Get themode property.

     const tank = document.querySelector('smart-tank');
     let mode = tank.mode;

    namestring

    Defines or retrieves the element's name attribute. This name uniquely identifies the element within a form and is used as the key when the form data is submitted to the server, allowing the associated value to be referenced and processed.

    Default value

    ""

    Example

    Set thename property.

     <smart-tank name='tank1'></smart-tank>

    Set thename property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.name = 'tank2';

    Get thename property.

     const tank = document.querySelector('smart-tank');
     let name = tank.name;

    orientation"horizontal" | "vertical"

    Specifies the layout direction of the widget, determining whether its content is arranged horizontally, vertically, or in another supported orientation.

    Default value

    "vertical"

    Example

    Set theorientation property.

     <smart-tank orientation='vertical'></smart-tank>

    Set theorientation property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.orientation = 'horizontal';

    Get theorientation property.

     const tank = document.querySelector('smart-tank');
     let orientation = tank.orientation;

    precisionDigitsnumber

    Specifies the number of digits to display after the decimal point in numeric values. This setting is only applicable whenscaleType is set to'integer'.

    Example

    Set theprecisionDigits property.

     <smart-tank precision-digits='5'></smart-tank>

    Set theprecisionDigits property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.precisionDigits = 6;

    Get theprecisionDigits property.

     const tank = document.querySelector('smart-tank');
     let precisionDigits = tank.precisionDigits;

    readonlyboolean

    If the widget is set to read-only, users will not be able to interact with or modify the element's content. Any input or actions from users will be disabled, ensuring that the widget's state remains unchanged.

    Default value

    false

    Example

    Set thereadonly property.

     <smart-tank readonly></smart-tank>

    Set thereadonly property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.readonly = true;

    Get thereadonly property.

     const tank = document.querySelector('smart-tank');
     let readonly = tank.readonly;

    rightToLeftboolean

    Gets or sets a value that specifies whether the element’s content is aligned to accommodate right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element’s alignment and text direction are adjusted for proper display in RTL locales.

    Default value

    false
    Try a demo showcasing therightToLeft property.

    Example

    Set therightToLeft property.

     <smart-tank right-to-left></smart-tank>

    Set therightToLeft property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.rightToLeft = true;

    Get therightToLeft property.

     const tank = document.querySelector('smart-tank');
     let rightToLeft = tank.rightToLeft;

    scalePosition"near" | "far" | "both" | "none"

    Specifies the placement of the widget’s scales relative to its main content, determining where the scale markers or labels appear within the widget interface (e.g., top, bottom, left, or right).

    Default value

    "near"

    Example

    Set thescalePosition property.

     <smart-tank scale-position='far'></smart-tank>

    Set thescalePosition property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.scalePosition = 'both';

    Get thescalePosition property.

     const tank = document.querySelector('smart-tank');
     let scalePosition = tank.scalePosition;

    scaleType"floatingPoint" | "integer"

    Specifies the measurement system used for the tank's scale, such as linear, logarithmic, or custom, which determines how values are displayed and interpreted on the tank's indicator.

    Default value

    "floatingPoint"

    Example

    Set thescaleType property.

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

    Set thescaleType property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.scaleType = 'floatingPoint';

    Get thescaleType property.

     const tank = document.querySelector('smart-tank');
     let scaleType = tank.scaleType;

    scientificNotationboolean

    Determines whether numerical values are displayed using scientific notation (e.g., 1.23e+6 instead of 1230000). Set to true to enable scientific notation, or false to display numbers in standard decimal format.

    Default value

    false

    Example

    Set thescientificNotation property.

     <smart-tank scientific-notation></smart-tank>

    Set thescientificNotation property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.scientificNotation = true;

    Get thescientificNotation property.

     const tank = document.querySelector('smart-tank');
     let scientificNotation = tank.scientificNotation;

    showThumbLabelboolean

    Controls whether the thumb label is visible or hidden. When enabled, the thumb label will be displayed alongside the slider's handle, providing users with a visual indicator of the current value. When disabled, the thumb label will not appear.

    Default value

    false

    Example

    Set theshowThumbLabel property.

     <smart-tank show-thumb-label></smart-tank>

    Set theshowThumbLabel property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.showThumbLabel = true;

    Get theshowThumbLabel property.

     const tank = document.querySelector('smart-tank');
     let showThumbLabel = tank.showThumbLabel;

    showTooltipboolean

    Controls whether the tooltip is visible to the user. When enabled, the tooltip will be displayed; when disabled, the tooltip will be hidden.

    Default value

    false

    Example

    Set theshowTooltip property.

     <smart-tank show-tooltip></smart-tank>

    Set theshowTooltip property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.showTooltip = true;

    Get theshowTooltip property.

     const tank = document.querySelector('smart-tank');
     let showTooltip = tank.showTooltip;

    showUnitboolean

    Controls whether unit labels (such as "kg", "cm", "°C") are shown alongside values. Set to true to display units next to values, or false to hide them.

    Default value

    false

    Example

    Set theshowUnit property.

     <smart-tank show-unit></smart-tank>

    Set theshowUnit property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.showUnit = false;

    Get theshowUnit property.

     const tank = document.querySelector('smart-tank');
     let showUnit = tank.showUnit;

    significantDigitsnumber

    Calculates the number of significant digits present in a given number. This process is only relevant and performed when thescaleType property is set to'integer'. This property should be used to ensure numerical data integrity and appropriate formatting for integer-based values.

    Default value

    0

    Example

    Set thesignificantDigits property.

     <smart-tank significant-digits='1'></smart-tank>

    Set thesignificantDigits property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.significantDigits = 2;

    Get thesignificantDigits property.

     const tank = document.querySelector('smart-tank');
     let significantDigits = tank.significantDigits;

    themestring

    Sets or retrieves the visual theme applied to the element, determining its overall appearance such as color scheme, typography, and style variants. This property allows dynamic customization of the element’s look to match different design requirements or user preferences.

    Default value

    ""

    Example

    Set thetheme property.

     <smart-tank theme='material'></smart-tank>

    Set thetheme property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.theme = 'material-purple';

    Get thetheme property.

     const tank = document.querySelector('smart-tank');
     let theme = tank.theme;

    thumbLabelPosition"near" | "far"

    Sets or retrieves the current position of the thumb label, typically representing the value indicator on a slider or range input. This property allows you to programmatically control or access the exact location of the label relative to the slider track.

    Default value

    "near"

    Example

    Set thethumbLabelPosition property.

     <smart-tank thumb-label-position='far'></smart-tank>

    Set thethumbLabelPosition property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.thumbLabelPosition = 'near';

    Get thethumbLabelPosition property.

     const tank = document.querySelector('smart-tank');
     let thumbLabelPosition = tank.thumbLabelPosition;

    ticksPosition"scale" | "track"

    Defines or retrieves the placement of the tick marks in the smartTank widget, specifying where the ticks are displayed relative to the tank (e.g., near, far, or both sides). This property allows you to control the visual positioning of the tick indicators along the scale of the smartTank widget.

    Default value

    "scale"

    Example

    Set theticksPosition property.

     <smart-tank ticks-position='track'></smart-tank>

    Set theticksPosition property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.ticksPosition = 'scale';

    Get theticksPosition property.

     const tank = document.querySelector('smart-tank');
     let ticksPosition = tank.ticksPosition;

    ticksVisibility"major" | "minor" | "none"

    Controls whether the ticks are visible or hidden. This property allows you to enable (show) or disable (hide) the display of tick marks on the relevant component. When set, it determines if ticks are rendered; when accessed, it returns the current visibility state of the ticks.

    Default value

    "minor"

    Example

    Set theticksVisibility property.

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

    Set theticksVisibility property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.ticksVisibility = 'none';

    Get theticksVisibility property.

     const tank = document.querySelector('smart-tank');
     let ticksVisibility = tank.ticksVisibility;

    tooltipPosition"near" | "far"

    Specifies or retrieves the position of the tooltip displayed on the smartTank widget. This property determines where the tooltip appears relative to the tank control (e.g., top, bottom, left, or right). Use this option to customize the tooltip's placement for improved user experience and interface alignment.

    Default value

    "near"

    Example

    Set thetooltipPosition property.

     <smart-tank tooltip-position='far'></smart-tank>

    Set thetooltipPosition property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.tooltipPosition = 'near';

    Get thetooltipPosition property.

     const tank = document.querySelector('smart-tank');
     let tooltipPosition = tank.tooltipPosition;

    unfocusableboolean

    Determines whether the element is focusable by setting or retrieving its ability to receive keyboard or mouse focus. If set to true, the element can be targeted by user interactions such as tab navigation or clicking.

    Default value

    false

    Example

    Set theunfocusable property.

     <smart-tank unfocusable></smart-tank>

    Set theunfocusable property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.unfocusable = false;

    Get theunfocusable property.

     const tank = document.querySelector('smart-tank');
     let unfocusable = tank.unfocusable;

    unitstring

    Specifies or retrieves the unit label displayed on the smartTank widget, indicating the measurement unit (e.g., "°C", "kg", "psi") associated with the tank's value. This property allows you to customize the text that appears alongside the value in the widget for better context and readability.

    Default value

    "kg"

    Example

    Set theunit property.

     <smart-tank unit='mm'></smart-tank>

    Set theunit property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.unit = 'cm';

    Get theunit property.

     const tank = document.querySelector('smart-tank');
     let unit = tank.unit;

    validation"strict" | "interaction"

    Enhances value validation using minimum and maximum boundaries.
    - When set to'strict', all values—whether changed by user interaction or programmatically—are always constrained within the definedmin andmax limits. Any attempt to set a value outside this range will automatically adjust (coerce) it to the closest valid boundary.
    - When set to'interaction', only values changed by user interaction (such as form input) are validated againstmin andmax. Programmatic updates can set values outside this range, and if themin ormax properties are later adjusted such that the current value falls out of bounds, the existing value remains unchanged and is not coerced. In these cases, nochange event is triggered.

    Default value

    "strict"

    Example

    Set thevalidation property.

     <smart-tank validation='left'></smart-tank>

    Set thevalidation property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.validation = 'right';

    Get thevalidation property.

     const tank = document.querySelector('smart-tank');
     let validation = tank.validation;

    valueany

    Gets the current value of the smartTank widget or sets it to a specified value. This property or method enables you to retrieve the widget's current position (value) or assign a new value programmatically, allowing for dynamic interaction and control over the smartTank component.

    Default value

    0

    Example

    Set thevalue property.

     <smart-tank value='50'></smart-tank>

    Set thevalue property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.value = 100;

    Get thevalue property.

     const tank = document.querySelector('smart-tank');
     let value = tank.value;

    wordLength"int8" | "uint8" | "int16" | "uint16" | "int32" | "uint32" | "int64" | "uint64"

    Specifies or retrieves the word length used for numeric representation. This property is relevant only when thescaleType is set to'integer'. In such cases, it determines the number of bits allocated for each integer value. For otherscaleType values, this setting has no effect.

    Default value

    "int32"

    Example

    Set thewordLength property.

     <smart-tank word-length='int8'></smart-tank>

    Set thewordLength property by using the HTML Element's instance.

     const tank = document.querySelector('smart-tank');
     tank.wordLength = 'int16';

    Get thewordLength property.

     const tank = document.querySelector('smart-tank');
     let wordLength = tank.wordLength;

    Events

    changeCustomEvent

    This event is triggered whenever the tank’s value is updated, whether through user interaction or programmatic changes. It allows listeners to respond immediately to any modification in the tank’s current state.

    • BubblesYes
    • CancelableNo
    • InterfaceCustomEvent
    • Event handler propertyonChange

    Arguments

    evCustomEvent

    Methods

    isDefaultPrevented

    Returnstrue if the event was preventedby any of its subscribers.

    Returns

    booleantrue if the default action was prevented.Otherwise, returnsfalse.

    preventDefault

    The preventDefault() method prevents the default action for a specified event.In this way, the source component suppressesthe built-in behavior that follows the event.

    stopPropagation

    The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

    Example

    Set up the event handler ofchange event.

    const tank = document.querySelector('smart-tank');tank.addEventListener('change', function (event) {// event handling code goes here.})

    Methods

    focus(): void

    Locks the keyboard and mouse input exclusively on the tank component, ensuring that all user interactions are directed to the tank (such as movement and firing controls) while disabling interactions with other interface elements.


    Invoke thefocus method.

    const tank = document.querySelector('smart-tank');tank.focus();

    getOptimalSize(): object

    Retrieves the recommended dimensions (width and height) for the widget based on its content and layout constraints, ensuring optimal display and usability.

    Returnsobject

    Invoke thegetOptimalSize method.

    const tank = document.querySelector('smart-tank');const result = tank.getOptimalSize();

    val(value?: string | number): string

    Retrieves or updates the current value stored in the tank. Use this property to access the tank’s value (such as its level, volume, or contents) or to assign a new value to it.

    Arguments

    value?string | number

    The value to be set. If no parameter is passed, returns the displayed value of the tank.

    Returnsstring

    Invoke theval method.

    const tank = document.querySelector('smart-tank');const result = tank.val("10");

    CSS Variables

    --smart-tank-default-widthvar()

    Default value

    "var(--smart-editor-width)"

    smartTank default width

    --smart-tank-default-heightvar()

    Default value

    "calc(10 * var(--smart-editor-height))"

    smartTank default height

    --smart-tank-scale-sizevar()

    Default value

    "105px"

    smartTank scale size

    --smart-tank-thumb-widthvar()

    Default value

    "25px"

    smartTank thumb width

    --smart-tank-thumb-heightvar()

    Default value

    "var(--smart-tank-thumb-width)"

    smartTank thumb height

    --smart-tank-tooltip-widthvar()

    Default value

    "80px"

    smartTank tooltip width

    --smart-tank-tooltip-heightvar()

    Default value

    "30px"

    smartTank thumb height

    --smart-tank-tick-sizevar()

    Default value

    "10px"

    smartTank tick size. Horizontal Tank tick height = Vertical Tank tick width.

    --smart-tank-minor-tick-sizevar()

    Default value

    "5px"

    smartTank minor tick size.

    --smart-tank-minimum-track-sizevar()

    Default value

    "6px"

    smartTank horizontal track min-height, vertical track min-width


    [8]ページ先頭
    ©2009-2025 Movatter.jp