ASP.NET MVC Controls
BulletGraph Class
File
wijmo.gauge.js
Module
wijmo.gauge
Base Class
LinearGauge

The BulletGraph is a type of linear gauge designed specifically for use in dashboards. It displays a single key measure along with a comparative measure and qualitative ranges to instantly signal whether the measure is good, bad, or in some other state.

Bullet Graphs were created and popularized by dashboard design expert Stephen Few. You can find more details and examples on Wikipedia.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(element: any, options?): BulletGraph

Initializes a new instance of the BulletGraph class.

Parameters
Returns
BulletGraph

Properties

bad

Gets or sets a reference value considered bad for the measure.

Type
number

Static controlTemplate

Gets or sets the template used to instantiate Gauge controls.

Inherited From
Gauge
Type
any

direction

Gets or sets the direction in which the gauge is filled.

Inherited From
LinearGauge
Type
GaugeDirection

face

Gets or sets the Range used to represent the gauge's overall geometry and appearance.

Inherited From
Gauge
Type
Range

format

Gets or sets the format string used to display gauge values as text.

Inherited From
Gauge
Type
string

getText

Gets or sets a callback that returns customized strings used to display gauge values.

Use this property if you want to customize the strings shown on the gauge in cases where the format property is not enough.

If provided, the callback should be a function as that takes as parameters the gauge, the part name, the value, and the formatted value. The callback should return the string to be displayed on the gauge.

For example:

// callback to convert values into strings
gauge.getText = function (gauge, part, value, text) {
  switch (part) {
    case 'value':
      if (value <= 10) return 'Empty!';
      if (value <= 25) return 'Low...';
      if (value <= 95) return 'Good';
      return 'Full';
    case 'min':
      return 'EMPTY';
    case 'max':
      return 'FULL';
  }
  return text;
}
Inherited From
Gauge
Type
Function

good

Gets or sets a reference value considered good for the measure.

Type
number

hasShadow

Gets or sets a value that indicates whether the gauge displays a shadow effect.

Inherited From
Gauge
Type
boolean

hostElement

Gets the DOM element that is hosting the control.

Inherited From
Control
Type
HTMLElement

isAnimated

Gets or sets a value that indicates whether the gauge animates value changes.

Inherited From
Gauge
Type
boolean

isDisabled

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.

Inherited From
Control
Type
boolean

isReadOnly

Gets or sets a value that indicates whether the user can edit the value using the mouse and keyboard.

Inherited From
Gauge
Type
boolean

isTouching

Gets a value that indicates whether the control is currently handling a touch event.

Inherited From
Control
Type
boolean

isUpdating

Gets a value that indicates whether the control is currently being updated.

Inherited From
Control
Type
boolean

max

Gets or sets the maximum value that can be displayed on the gauge.

For details about using the min and max properties, please see the Using the min and max properties topic.

Inherited From
Gauge
Type
number

min

Gets or sets the minimum value that can be displayed on the gauge.

For details about using the min and max properties, please see the Using the min and max properties topic.

Inherited From
Gauge
Type
number

origin

Gets or sets the starting point used for painting the range.

By default, this property is set to null, which causes the value range to start at the gauge's minimum value, or zero if the minimum is less than zero.

Inherited From
Gauge
Type
number

pointer

Gets or sets the Range used to represent the gauge's current value.

Inherited From
Gauge
Type
Range

ranges

Gets the collection of ranges in this gauge.

Inherited From
Gauge
Type
ObservableArray

rightToLeft

Gets a value indicating whether the control is hosted in an element with right-to-left layout.

Inherited From
Control
Type
boolean

showRanges

Gets or sets a value that indicates whether the gauge displays the ranges contained in the ranges property.

If this property is set to false, the ranges contained in the ranges property are not displayed in the gauge. Instead, they are used to interpolate the color of the pointer range while animating value changes.

Inherited From
Gauge
Type
boolean

showText

Gets or sets the ShowText values to display as text in the gauge.

Inherited From
Gauge
Type
ShowText

showTicks

Gets or sets a property that determines whether the gauge should display tickmarks at each step value.

The tickmarks can be formatted in CSS using the wj-gauge and wj-ticks class names. For example:

.wj-gauge .wj-ticks {
    stroke-width: 2px;
    stroke: white;
}
Inherited From
Gauge
Type
boolean

step

Gets or sets the amount to add to or subtract from the value property when the user presses the arrow keys or moves the mouse wheel.

Inherited From
Gauge
Type
number

target

Gets or sets the target value for the measure.

Type
number

thickness

Gets or sets the thickness of the gauge, on a scale between zero and one.

Setting the thickness to one causes the gauge to fill as much of the control area as possible. Smaller values create thinner gauges.

Inherited From
Gauge
Type
number

thumbSize

Gets or sets the size of the element that shows the gauge's current value, in pixels.

Inherited From
Gauge
Type
number

value

Gets or sets the value to display on the gauge.

Inherited From
Gauge
Type
number

Methods

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean): void

Adds an event listener to an element owned by this Control.

The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener method).

Failing to remove event listeners may cause memory leaks.

Parameters
  • target: EventTarget

    Target element for the event.

  • type: string

    String that specifies the event.

  • fn: any

    Function to execute when the event occurs.

  • capture: boolean Optional

    Whether the listener is capturing.

Inherited From
Control
Returns
void

applyTemplate

applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

Applies the template to a new instance of a control, and returns the root element.

This method should be called by constructors of templated controls. It is responsible for binding the template parts to the corresponding control members.

For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.

this.applyTemplate('wj-control wj-inputnumber', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');
Parameters
  • classNames: string

    Names of classes to add to the control's host element.

  • template: string

    An HTML string that defines the control template.

  • parts: Object

    A dictionary of part variables and their names.

  • namePart: string Optional

    Name of the part to be named after the host element. This determines how the control submits data when used in forms.

Inherited From
Control
Returns
HTMLElement

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
Control
Returns
void

containsFocus

containsFocus(): boolean

Checks whether this control contains the focused element.

Inherited From
Control
Returns
boolean

deferUpdate

deferUpdate(fn: Function): void

Executes a function within a beginUpdate/endUpdate block.

The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.

Parameters
Inherited From
Control
Returns
void

dispose

dispose(): void

Disposes of the control by removing its association with the host element.

The dispose method automatically removes any event listeners added with the addEventListener method.

Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

Inherited From
Control
Returns
void

Static disposeAll

disposeAll(e?: HTMLElement): void

Disposes of all Wijmo controls contained in an HTML element.

Parameters
Inherited From
Control
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by calls to beginUpdate.

Inherited From
Control
Returns
void

focus

focus(): void

Sets the focus to this control.

Inherited From
Control
Returns
void

Static getControl

getControl(element: any): Control

Gets the control that is hosted in a given DOM element.

Parameters
  • element: any

    The DOM element that is hosting the control, or a selector for the host element (e.g. '#theCtrl').

Inherited From
Control
Returns
Control

getTemplate

getTemplate(): string

Gets the HTML template used to create instances of the control.

This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, it will override the template defined by the DropDown base class.

Inherited From
Control
Returns
string

hitTest

hitTest(pt: any, y?: number): number

Gets a number that corresponds to the value of the gauge at a given point.

For example:

// hit test a point when the user clicks on the gauge
gauge.hostElement.addEventListener('click', function (e) {
  var ht = gauge.hitTest(e.pageX, e.pageY);
  if (ht != null) {
    console.log('you clicked the gauge at value ' + ht.toString());
  }
});
Parameters
  • pt: any

    The point to investigate, in window coordinates, or a MouseEvent object, or the x coordinate of the point.

  • y: number Optional

    The Y coordinate of the point (if the first parameter is a number).

Inherited From
Gauge
Returns
number

initialize

initialize(options: any): void

Initializes the control by copying the properties from a given object.

This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.

For example:

grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 } 
  ]
});

// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;

// etc.

The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.

Parameters
  • options: any

    Object that contains the initialization data.

Inherited From
Control
Returns
void

invalidate

invalidate(fullUpdate?: boolean): void

Invalidates the control causing an asynchronous refresh.

Parameters
  • fullUpdate: boolean Optional

    Whether to update the control layout as well as the content.

Inherited From
Control
Returns
void

Static invalidateAll

invalidateAll(e?: HTMLElement): void

Invalidates all Wijmo controls contained in an HTML element.

Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.

If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.

Parameters
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

Inherited From
Control
Returns
void

onGotFocus

onGotFocus(e?: EventArgs): void

Raises the gotFocus event.

Parameters
Inherited From
Control
Returns
void

onLostFocus

onLostFocus(e?: EventArgs): void

Raises the lostFocus event.

Parameters
Inherited From
Control
Returns
void

onValueChanged

onValueChanged(e?: EventArgs): void

Raises the valueChanged event.

Parameters
Inherited From
Gauge
Returns
void

refresh

refresh(fullUpdate?: boolean): void

Refreshes the control.

Parameters
  • fullUpdate: boolean Optional

    Indicates whether to update the control layout as well as the content.

Inherited From
Gauge
Returns
void

Static refreshAll

refreshAll(e?: HTMLElement): void

Refreshes all Wijmo controls contained in an HTML element.

This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.

Parameters
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

Inherited From
Control
Returns
void

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

Removes one or more event listeners attached to elements owned by this Control.

Parameters
  • target: EventTarget Optional

    Target element for the event. If null, removes listeners attached to all targets.

  • type: string Optional

    String that specifies the event. If null, removes listeners attached to all events.

  • fn: any Optional

    Handler to remove. If null, removes all handlers.

  • capture: boolean Optional

    Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

Inherited From
Control
Returns
number

Events

gotFocus

Occurs when the control gets the focus.

Inherited From
Control
Arguments
EventArgs

lostFocus

Occurs when the control loses the focus.

Inherited From
Control
Arguments
EventArgs

valueChanged

Occurs when the value of the value property changes.

Inherited From
Gauge
Arguments
EventArgs

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback