ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class LinearGaugeBuilder

    Show / Hide Table of Contents

    Class LinearGaugeBuilder

    Inheritance
    System.Object
    ControlBuilder
    LinearGaugeBuilder
    Inherited Members
    ControlBuilder.Context
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.LinearGauge
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class LinearGaugeBuilder : ControlBuilder

    Constructors

    LinearGaugeBuilder()

    Declaration
    public LinearGaugeBuilder()

    LinearGaugeBuilder(LinearGauge)

    Declaration
    public LinearGaugeBuilder(LinearGauge model)
    Parameters
    Type Name Description
    LinearGauge model

    Fields

    model

    Declaration
    public LinearGauge model
    Field Value
    Type Description
    LinearGauge

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    AllowImageExport(Boolean)

    Enables or disables the export to image functionality in linear gauge.

    Declaration
    public LinearGaugeBuilder AllowImageExport(bool allowImageExport = true)
    Parameters
    Type Name Description
    System.Boolean allowImageExport
    Returns
    Type Description
    LinearGaugeBuilder

    AllowMargin(Boolean)

    Enables or disables the ability of the gauge to be rendered to the complete width. The left, right, top and bottom spacing will not be considered in the gauge when this property is disabled.

    Declaration
    public LinearGaugeBuilder AllowMargin(bool allowMargin = true)
    Parameters
    Type Name Description
    System.Boolean allowMargin
    Returns
    Type Description
    LinearGaugeBuilder

    AllowPdfExport(Boolean)

    Enables or disables the export to PDF functionality in linear gauge.

    Declaration
    public LinearGaugeBuilder AllowPdfExport(bool allowPdfExport = true)
    Parameters
    Type Name Description
    System.Boolean allowPdfExport
    Returns
    Type Description
    LinearGaugeBuilder

    AllowPrint(Boolean)

    Enables or disables the print functionality in linear gauge.

    Declaration
    public LinearGaugeBuilder AllowPrint(bool allowPrint = true)
    Parameters
    Type Name Description
    System.Boolean allowPrint
    Returns
    Type Description
    LinearGaugeBuilder

    AnimationComplete(String)

    Triggers after completing the animation for pointer.

    Declaration
    public LinearGaugeBuilder AnimationComplete(string animationComplete)
    Parameters
    Type Name Description
    System.String animationComplete
    Returns
    Type Description
    LinearGaugeBuilder

    AnnotationRender(String)

    Triggers before each annotation gets rendered.

    Declaration
    public LinearGaugeBuilder AnnotationRender(string annotationRender)
    Parameters
    Type Name Description
    System.String annotationRender
    Returns
    Type Description
    LinearGaugeBuilder

    Annotations(Action<LinearGaugeAnnotationBuilder>)

    Declaration
    public LinearGaugeBuilder Annotations(Action<LinearGaugeAnnotationBuilder> annotations)
    Parameters
    Type Name Description
    System.Action<LinearGaugeAnnotationBuilder> annotations
    Returns
    Type Description
    LinearGaugeBuilder

    Annotations(List<LinearGaugeAnnotation>)

    Specifies the options for customizing the annotation of linear gauge.

    Declaration
    public LinearGaugeBuilder Annotations(List<LinearGaugeAnnotation> annotations)
    Parameters
    Type Name Description
    System.Collections.Generic.List<LinearGaugeAnnotation> annotations
    Returns
    Type Description
    LinearGaugeBuilder

    Axes(Action<LinearGaugeAxisBuilder>)

    Declaration
    public LinearGaugeBuilder Axes(Action<LinearGaugeAxisBuilder> axes)
    Parameters
    Type Name Description
    System.Action<LinearGaugeAxisBuilder> axes
    Returns
    Type Description
    LinearGaugeBuilder

    Axes(List<LinearGaugeAxis>)

    Specifies the options for customizing the axis in linear gauge.

    Declaration
    public LinearGaugeBuilder Axes(List<LinearGaugeAxis> axes)
    Parameters
    Type Name Description
    System.Collections.Generic.List<LinearGaugeAxis> axes
    Returns
    Type Description
    LinearGaugeBuilder

    AxisLabelRender(String)

    Triggers before each axis label gets rendered.

    Declaration
    public LinearGaugeBuilder AxisLabelRender(string axisLabelRender)
    Parameters
    Type Name Description
    System.String axisLabelRender
    Returns
    Type Description
    LinearGaugeBuilder

    Background(String)

    Specifies the background color of the gauge. This property accepts value in hex code, rgba string as a valid CSS color string.

    Declaration
    public LinearGaugeBuilder Background(string background)
    Parameters
    Type Name Description
    System.String background
    Returns
    Type Description
    LinearGaugeBuilder

    BeforePrint(String)

    Triggers before the print functionality gets started.

    Declaration
    public LinearGaugeBuilder BeforePrint(string beforePrint)
    Parameters
    Type Name Description
    System.String beforePrint
    Returns
    Type Description
    LinearGaugeBuilder

    Border(LinearGaugeBorder)

    Specifies the options for customizing the style properties of the border for linear gauge.

    Declaration
    public LinearGaugeBuilder Border(LinearGaugeBorder border)
    Parameters
    Type Name Description
    LinearGaugeBorder border
    Returns
    Type Description
    LinearGaugeBuilder

    Border(Action<LinearGaugeBorderBuilder>)

    Declaration
    public LinearGaugeBuilder Border(Action<LinearGaugeBorderBuilder> border)
    Parameters
    Type Name Description
    System.Action<LinearGaugeBorderBuilder> border
    Returns
    Type Description
    LinearGaugeBuilder

    Container(LinearGaugeContainer)

    Specifies the options for customizing the container in linear gauge.

    Declaration
    public LinearGaugeBuilder Container(LinearGaugeContainer container)
    Parameters
    Type Name Description
    LinearGaugeContainer container
    Returns
    Type Description
    LinearGaugeBuilder

    Container(Action<LinearGaugeContainerBuilder>)

    Declaration
    public LinearGaugeBuilder Container(Action<LinearGaugeContainerBuilder> container)
    Parameters
    Type Name Description
    System.Action<LinearGaugeContainerBuilder> container
    Returns
    Type Description
    LinearGaugeBuilder

    Description(String)

    Sets and gets the information about gauge for assistive technology.

    Declaration
    public LinearGaugeBuilder Description(string description)
    Parameters
    Type Name Description
    System.String description
    Returns
    Type Description
    LinearGaugeBuilder

    DragEnd(String)

    Triggers after the pointer is dragged.

    Declaration
    public LinearGaugeBuilder DragEnd(string dragEnd)
    Parameters
    Type Name Description
    System.String dragEnd
    Returns
    Type Description
    LinearGaugeBuilder

    DragMove(String)

    Triggers while dragging the pointers.

    Declaration
    public LinearGaugeBuilder DragMove(string dragMove)
    Parameters
    Type Name Description
    System.String dragMove
    Returns
    Type Description
    LinearGaugeBuilder

    DragStart(String)

    Triggers before the pointer is dragged.

    Declaration
    public LinearGaugeBuilder DragStart(string dragStart)
    Parameters
    Type Name Description
    System.String dragStart
    Returns
    Type Description
    LinearGaugeBuilder

    EdgeLabelPlacement(LabelPlacement)

    Specifies the placement of the label in linear gauge.

    Declaration
    public LinearGaugeBuilder EdgeLabelPlacement(LabelPlacement edgeLabelPlacement)
    Parameters
    Type Name Description
    LabelPlacement edgeLabelPlacement
    Returns
    Type Description
    LinearGaugeBuilder

    EnablePersistence(Boolean)

    Enable or disable persisting component's state between page reloads.

    Declaration
    public LinearGaugeBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    LinearGaugeBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public LinearGaugeBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    LinearGaugeBuilder

    Format(String)

    Specifies the format to apply for internationalization in linear gauge.

    Declaration
    public LinearGaugeBuilder Format(string format)
    Parameters
    Type Name Description
    System.String format
    Returns
    Type Description
    LinearGaugeBuilder

    GaugeMouseDown(String)

    Triggers when performing the mouse down operation on gauge area.

    Declaration
    public LinearGaugeBuilder GaugeMouseDown(string gaugeMouseDown)
    Parameters
    Type Name Description
    System.String gaugeMouseDown
    Returns
    Type Description
    LinearGaugeBuilder

    GaugeMouseLeave(String)

    Triggers when performing the mouse leave operation from the gauge area.

    Declaration
    public LinearGaugeBuilder GaugeMouseLeave(string gaugeMouseLeave)
    Parameters
    Type Name Description
    System.String gaugeMouseLeave
    Returns
    Type Description
    LinearGaugeBuilder

    GaugeMouseMove(String)

    Triggers when performing the mouse move operation on gauge area.

    Declaration
    public LinearGaugeBuilder GaugeMouseMove(string gaugeMouseMove)
    Parameters
    Type Name Description
    System.String gaugeMouseMove
    Returns
    Type Description
    LinearGaugeBuilder

    GaugeMouseUp(String)

    Triggers when performing mouse up operation on gauge area.

    Declaration
    public LinearGaugeBuilder GaugeMouseUp(string gaugeMouseUp)
    Parameters
    Type Name Description
    System.String gaugeMouseUp
    Returns
    Type Description
    LinearGaugeBuilder

    Height(String)

    Specifies the height of the linear gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full height of its parent element.

    Declaration
    public LinearGaugeBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    LinearGaugeBuilder

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public LinearGaugeBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    LinearGaugeBuilder

    Load(String)

    Triggers before the gauge gets rendered.

    Declaration
    public LinearGaugeBuilder Load(string load)
    Parameters
    Type Name Description
    System.String load
    Returns
    Type Description
    LinearGaugeBuilder

    Loaded(String)

    Triggers after the gauge gets rendered.

    Declaration
    public LinearGaugeBuilder Loaded(string loaded)
    Parameters
    Type Name Description
    System.String loaded
    Returns
    Type Description
    LinearGaugeBuilder

    Locale(String)

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public LinearGaugeBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    LinearGaugeBuilder

    Margin(LinearGaugeMargin)

    Specifies the options to customize the margins of the linear gauge.

    Declaration
    public LinearGaugeBuilder Margin(LinearGaugeMargin margin)
    Parameters
    Type Name Description
    LinearGaugeMargin margin
    Returns
    Type Description
    LinearGaugeBuilder

    Margin(Action<LinearGaugeMarginBuilder>)

    Declaration
    public LinearGaugeBuilder Margin(Action<LinearGaugeMarginBuilder> margin)
    Parameters
    Type Name Description
    System.Action<LinearGaugeMarginBuilder> margin
    Returns
    Type Description
    LinearGaugeBuilder

    Orientation(Orientation)

    Specifies the orientation of the rendering of the linear gauge.

    Declaration
    public LinearGaugeBuilder Orientation(Orientation orientation)
    Parameters
    Type Name Description
    Orientation orientation
    Returns
    Type Description
    LinearGaugeBuilder

    RangePalettes(String[])

    Specifies the color palette for axis ranges in linear gauge.

    Declaration
    public LinearGaugeBuilder RangePalettes(string[] rangePalettes)
    Parameters
    Type Name Description
    System.String[] rangePalettes
    Returns
    Type Description
    LinearGaugeBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    System.Web.HtmlString

    Resized(String)

    Triggers to notify the resize of the linear gauge when the window is resized.

    Declaration
    public LinearGaugeBuilder Resized(string resized)
    Parameters
    Type Name Description
    System.String resized
    Returns
    Type Description
    LinearGaugeBuilder

    TabIndex(Double)

    Specifies the tab index value for the linear gauge.

    Declaration
    public LinearGaugeBuilder TabIndex(double tabIndex)
    Parameters
    Type Name Description
    System.Double tabIndex
    Returns
    Type Description
    LinearGaugeBuilder

    Theme(LinearGaugeTheme)

    Sets and gets the theme styles supported for linear gauge. When the theme is set, the styles associated with the theme will be set in the gauge.

    Declaration
    public LinearGaugeBuilder Theme(LinearGaugeTheme theme)
    Parameters
    Type Name Description
    LinearGaugeTheme theme
    Returns
    Type Description
    LinearGaugeBuilder

    Title(String)

    Specifies the title for linear gauge.

    Declaration
    public LinearGaugeBuilder Title(string title)
    Parameters
    Type Name Description
    System.String title
    Returns
    Type Description
    LinearGaugeBuilder

    TitleStyle(LinearGaugeFont)

    Specifies the options for customizing the appearance of title for linear gauge.

    Declaration
    public LinearGaugeBuilder TitleStyle(LinearGaugeFont titleStyle)
    Parameters
    Type Name Description
    LinearGaugeFont titleStyle
    Returns
    Type Description
    LinearGaugeBuilder

    TitleStyle(Action<LinearGaugeFontBuilder>)

    Declaration
    public LinearGaugeBuilder TitleStyle(Action<LinearGaugeFontBuilder> titleStyle)
    Parameters
    Type Name Description
    System.Action<LinearGaugeFontBuilder> titleStyle
    Returns
    Type Description
    LinearGaugeBuilder

    Tooltip(LinearGaugeTooltipSettings)

    Specifies the options for customizing the tooltip in linear gauge.

    Declaration
    public LinearGaugeBuilder Tooltip(LinearGaugeTooltipSettings tooltip)
    Parameters
    Type Name Description
    LinearGaugeTooltipSettings tooltip
    Returns
    Type Description
    LinearGaugeBuilder

    Tooltip(Action<LinearGaugeTooltipSettingsBuilder>)

    Declaration
    public LinearGaugeBuilder Tooltip(Action<LinearGaugeTooltipSettingsBuilder> tooltip)
    Parameters
    Type Name Description
    System.Action<LinearGaugeTooltipSettingsBuilder> tooltip
    Returns
    Type Description
    LinearGaugeBuilder

    TooltipRender(String)

    Triggers before the tooltip get rendered.

    Declaration
    public LinearGaugeBuilder TooltipRender(string tooltipRender)
    Parameters
    Type Name Description
    System.String tooltipRender
    Returns
    Type Description
    LinearGaugeBuilder

    UseGroupingSeparator(Boolean)

    Enables or disables a grouping separator should be used for a number.

    Declaration
    public LinearGaugeBuilder UseGroupingSeparator(bool useGroupingSeparator = true)
    Parameters
    Type Name Description
    System.Boolean useGroupingSeparator
    Returns
    Type Description
    LinearGaugeBuilder

    ValueChange(String)

    Triggers while changing the value of the pointer by UI interaction.

    Declaration
    public LinearGaugeBuilder ValueChange(string valueChange)
    Parameters
    Type Name Description
    System.String valueChange
    Returns
    Type Description
    LinearGaugeBuilder

    Width(String)

    Specifies the width of the linear gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full width of its parent element.

    Declaration
    public LinearGaugeBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    LinearGaugeBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved