RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxLinearGauge/Configuration/ below:

Vue LinearGauge Props | Vue Documentation

An object that defines configuration properties for the LinearGauge UI component.

Specifies animation properties.

Selector: DxAnimation

Type: viz/gauges/base_gauge:BaseGaugeAnimation

To make your gauge "live", enable animation for it by setting the enabled property of the animation object to true. In this instance, the gauge indicators will appear in motion. In addition, within the animation object, you can set an appropriate easing mode using the easing property and specify how long the animation should run using the duration property.

jQuery

$(function() {
    $("#linearGaugeContainer").dxLinearGauge({
        // ...
        animation: {
            easing: "linear",
            duration: 500
        }
    });
});

Angular

<dx-linear-gauge ... >
    <dxo-animation
        easing="linear"
        [duration]="500">
    </dxo-animation>
</dx-linear-gauge>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxLinearGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxLinearGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxLinearGauge ... >
        <DxAnimation
            easing="linear"
            :duration="500"
        />
    </DxLinearGauge>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxLinearGauge, {
    DxAnimation
} from 'devextreme-vue/linear-gauge';

export default {
    components: {
        DxLinearGauge,
        DxAnimation
    },
    // ...
}
</script>

React

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import LinearGauge, {
    Animation 
} from 'devextreme-react/linear-gauge';

class App extends React.Component {
    render() {
        return (
            <LinearGauge ... >
                <Animation
                    easing="linear"
                    duration={500}
                />
            </LinearGauge>
        );
    }
}
export default App;

ASP.NET MVC Controls

@(Html.DevExtreme().LinearGauge()
    @* ... *@
    .Animation(a => a
        .Easing(VizAnimationEasing.Linear)
        .Duration(500)
    )
)

Specifies the color of the parent page element.

Selector: container-background-color

Default Value: 'none'

Set this property to the color of the parent page element. Certain elements of the UI component will use this color so that they coordinate with the page. Currently, different auxiliary separators use the container background color, so there is no need to set a custom color for them.

This property supports the following colors:

Hexadecimal colors
RGB colors
RGBA colors
Predefined/cross-browser color names
Predefined SVG colors
Paint server address

Specifies whether the UI component responds to user interaction.

Default Value: false

Cannot be used in themes.

Specifies the global attributes to be attached to the UI component's container element.

Selector: DxElementAttr

Default Value: {}

jQuery

$(function(){
    $("#linearGaugeContainer").dxLinearGauge({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

<dx-linear-gauge ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-linear-gauge>

import { DxLinearGaugeModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxLinearGaugeModule
    ],
    // ...
})

Vue

<template>
    <DxLinearGauge ...
        :element-attr="linearGaugeAttributes">
    </DxLinearGauge>
</template>

<script>
import DxLinearGauge from 'devextreme-vue/linear-gauge';

export default {
    components: {
        DxLinearGauge
    },
    data() {
        return {
            linearGaugeAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

import React from 'react';

import LinearGauge from 'devextreme-react/linear-gauge';

class App extends React.Component {
    linearGaugeAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <LinearGauge ...
                elementAttr={this.linearGaugeAttributes}>
            </LinearGauge>
        );
    }
}
export default App;

Configures the exporting and printing features.

Selector: DxExport

Type: viz/core/base_widget:BaseWidgetExport

Specifies the properties required to set the geometry of the LinearGauge UI component.

Configures the loading indicator.

Selector: DxLoadingIndicator

Type: viz/gauges/base_gauge:BaseGaugeLoadingIndicator

When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.

To change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.

Generates space around the UI component.

Selector: DxMargin

Type: viz/core/base_widget:BaseWidgetMargin

jQuery

$(function() {
    $("#linearGaugeContainer").dxLinearGauge({
        // ...
        margin: {
            top: 20,
            bottom: 20,
            left: 30,
            right: 30
        }
    });
});

Angular

<dx-linear-gauge ... >
    <dxo-margin
        [top]="20"
        [bottom]="20"
        [left]="30"
        [right]="30">
    </dxo-margin>
</dx-linear-gauge>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxLinearGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxLinearGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxLinearGauge ... >
        <DxMargin
            :top="20"
            :bottom="20"
            :left="30"
            :right="30"
        />
    </DxLinearGauge>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxLinearGauge, {
    DxMargin 
} from 'devextreme-vue/linear-gauge';

export default {
    components: {
        DxLinearGauge,
        DxMargin
    },
    // ...
}
</script>

React

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import LinearGauge, {
    Margin 
} from 'devextreme-react/linear-gauge';

class App extends React.Component {
    render() {
        return (
            <LinearGauge ... >
                <Margin
                    top={20}
                    bottom={20}
                    left={30}
                    right={30}
                />
            </LinearGauge>
        );
    }
}
export default App;

A function that is executed before the UI component is disposed of.

Selector: @disposing

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component's rendering has finished.

Selector: @drawn

Function parameters:

Information about the event.

Object structure:

Default Value: null

Cannot be used in themes.

A function that is executed after the UI component is exported.

Selector: @exported

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed before the UI component is exported.

Selector: @exporting

Function parameters:

Information about the event.

Object structure:

Name Type Description format

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

fileName

String

The name of the file to which the UI component is about to be exported.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

LinearGauge

The UI component's instance.

Default Value: null

A function that is executed before a file with exported UI component is saved to the user's local storage.

Selector: @file-saving

Function parameters:

Information about the event.

Object structure:

Name Type Description format

String

The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

fileName

String

The name of the file to be saved.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

data

BLOB

Exported data as a BLOB.

component

LinearGauge

The UI component's instance.

cancel

Boolean

Allows you to prevent file saving.

Default Value: null

A function that is executed when an error or warning occurs.

Selector: @incident-occurred

Function parameters:

Information about the event.

Object structure:

Default Value: null

The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

id
The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
type
The incident's type: "error" or "warning".
args
The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
text
The text passed to the browser's console. Includes the args content, if there is any.
widget
The name of the UI component that produced the error or warning.
version
The used DevExtreme version.

A function used in JavaScript frameworks to save the UI component instance.

Selector: @initialized

Function parameters:

Information about the event.

Object structure:

Default Value: null

Angular

<dx-linear-gauge ...
    (onInitialized)="saveInstance($event)">
</dx-linear-gauge>

import { Component } from "@angular/core";
import LinearGauge from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    linearGaugeInstance: LinearGauge;
    saveInstance (e) {
        this.linearGaugeInstance = e.component;
    }
}

Vue

App.vue (Composition API)

<template>
    <div>
        <DxLinearGauge ...
            @initialized="saveInstance">
        </DxLinearGauge>
    </div>
</template>

<script>
import DxLinearGauge from 'devextreme-vue/linear-gauge';

export default {
    components: {
        DxLinearGauge
    },
    data: function() {
        return {
            linearGaugeInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.linearGaugeInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxLinearGauge ...
            @initialized="saveInstance">
        </DxLinearGauge>
    </div>
</template>

<script setup>
import DxLinearGauge from 'devextreme-vue/linear-gauge';

let linearGaugeInstance = null;

const saveInstance = (e) => {
    linearGaugeInstance = e.component;
}
</script>

React

import LinearGauge from 'devextreme-react/linear-gauge';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.linearGaugeInstance = e.component;
    }

    render() {
        return (
            <div>
                <LinearGauge onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

DevExpress.viz.refreshPaths()

Specifies gauge range container properties.

Selector: DxRangeContainer

For the purpose of more intelligible data visualization, you can combine values into ranges and color each range differently. For instance, you can indicate the range of warm and cold temperatures. To set the ranges, assign an array of objects defining the ranges to the ranges property of the rangeContainer configuration object. In addition, you can specify the orientation of the ranges relative to an invisible scale line, and an offset from this line using the rangeContainer properties.

Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates.

Selector: redraw-on-resize

Default Value: true

Cannot be used in themes.

When this property is set to true, the UI component will be redrawn automatically in case the size of its container changes.

Switches the UI component to a right-to-left representation.

Selector: rtl-enabled

Default Value: false

Cannot be used in themes.

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

In a right-to-left representation, SVG elements have the

direction

attribute with the

rtl

value. This might cause problems when rendering left-to-right texts. Use this property if you have only right-to-left texts.

Specifies the gauge's scale properties.

To divide a scale, set its startValue and endValue properties. The scale's major and minor ticks will be calculated automatically. Major ticks will be shown by default. To show minor ticks, set their visible property to true. You can set custom major and minor tick intervals, show custom major and minor ticks, and format tick labels. These and other scale properties are available in the scale configuration object.

Specifies the UI component's size in pixels. The default value depends on the component's orientation.

Selector: DxSize

Type: viz/core/base_widget:BaseWidgetSize

Default Value: {height: 100, width: 300} | {height: 300, width: 100}

The default size of the component depends on the geometry.orientation property value:

{
    height: 100,
    width: 300
}

{
    height: 300,
    width: 100
}

You can specify a custom width and height for the component:

Fixed Relative Assign values to the size object's height and width properties or specify a container for the component. Specify a container for the component. The component occupies the container area.

The size object has priority over the container.

Assign 0 to the size object's height and width properties to hide the component.

jQuery

$(function() {
    $("#linearGaugeContainer").dxLinearGauge({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

Angular

<dx-linear-gauge ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-linear-gauge>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxLinearGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxLinearGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxLinearGauge ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxLinearGauge>
</template>

<script>

import DxLinearGauge, {
    DxSize
} from 'devextreme-vue/linear-gauge';

export default {
    components: {
        DxLinearGauge,
        DxSize
    },
    // ...
}
</script>

React

import React from 'react';

import LinearGauge, {
    Size
} from 'devextreme-react/linear-gauge';

class App extends React.Component {
    render() {
        return (
            <LinearGauge ... >
                <Size
                    height={300}
                    width={600}
                />
            </LinearGauge>
        );
    }
}
export default App;

Alternatively, you can use CSS to style the UI component's container:

jQuery

$(function() {
    $("#linearGauge").dxLinearGauge({
        // ...
    });
});

#linearGauge {
    width: 85%;
    height: 70%;
}

Angular

<dx-linear-gauge ...
    id="linearGauge">
</dx-linear-gauge>

#linearGauge {
    width: 85%;
    height: 70%;
}

Vue

<template>
    <DxLinearGauge ...
        id="linearGauge">
    </DxLinearGauge>
</template>

<script>
import DxLinearGauge from 'devextreme-vue/linear-gauge';

export default {
    components: {
        DxLinearGauge
    },
    // ...
}
</script>

<style>
#linearGauge {
    width: 85%;
    height: 70%;
}
</style>

React

import React from 'react';

import LinearGauge from 'devextreme-react/linear-gauge';

class App extends React.Component {
    render() {
        return (
            <LinearGauge ...
                id="linearGauge">
            </LinearGauge>
        );
    }
}
export default App;

#linearGauge {
    width: 85%;
    height: 70%;
}

Specifies the appearance properties of subvalue indicators.

Selector: DxSubvalueIndicator

The LinearGauge UI component can display one main value and several subvalues. The gauge's main value and subvalues are indicated by special pointers. You can customize the appearance of these pointers using the valueIndicator and subvalueIndicator configuration objects correspondingly.

The subvalue indicator is a pointer, which designates an extra value on a scale. There are several types of subvalue indicators. Set the required one by using the type property, and then specify the properties that are specific to this type, if needed. To learn the properties that can be specified for a particular type, refer to one of the following sections.

View Demo

Specifies a set of subvalues to be designated by the subvalue indicators.

Default Value: undefined

Cannot be used in themes.

In addition to one main value, you can indicate several extra values on a gauge. These are called subvalues. To specify the subvalues, assign an array with them to the subvalues field.

You can obtain and change the subvalues at runtime. In order to do this, use the subvalues() and subvalues(subvalues) methods. Note that in that case, you need to initialize the subvalues property at least with an empty array.

var gaugeOptions = {
    // ...
    subvalues: []    
}

Subvalues are designated by subvalue indicators. You can customize the appearance of these indicators using the subvalueIndicator configuration object.

View Demo

Sets the name of the theme the UI component uses.

Default Value: 'generic.light'

A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.

Configures the UI component's title.

Selector: DxTitle

Type: viz/core/base_widget:BaseWidgetTitle

The UI component's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title property. Otherwise, set this property to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

Configures tooltips.

Selector: DxTooltip

Type: viz/gauges/base_gauge:BaseGaugeTooltip

A tooltip is a miniature rectangle displaying the value of a gauge's indicator. A tooltip appears when the end-user hovers the cursor over an indicator. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

Specifies the main value on a gauge.

Default Value: undefined

Cannot be used in themes.

The main value is designated by the value indicator. To customize the appearance of the value indicator, use the valueIndicator configuration object.

You can obtain and change the gauge value at runtime. In order to do this, use the value() and value(value) methods.

Only one main value can be indicated on a gauge. Besides the main gauge value, you can indicate several extra values. Refer to the subvalues property description for more information.