Class: Histogram

• [new Histogram(options, bounds, bins)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.shapes-1.histogram.histogram.md#new histogram(options, bounds, bins))

• new Histogram(options?, bounds?, bins?)

Create Histogram

Shape.constructor

▸ addCssClass(cssclass): Histogram

Adds new css class to node

Histogram

this

Shape.addCssClass

▸ addInvalidateHandler(handler): Histogram

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Histogram

this

Shape.addInvalidateHandler

▸ Protected applyOpacity(context): Histogram

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

Histogram

this

Shape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Shape.applyResponsiveStyle

▸ areValuesCustomized(): boolean

Resets the highest and lowest values to be computed values

boolean

_areCustomizedEdges

▸ calculate(keepModelLimits?): Histogram

Calculate distribution with normalization

Histogram

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendarable area

Shape.checkCollision

▸ clone(): Node

All subclasses should override copyConstructor or provide custom implementation for this method

Node

clone

Shape.clone

▸ computeStatistics(): void

Computers the statics based on the new data

void

▸ connectStyle(style, type, callback): Histogram

Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> And automatically un-subscribes listener if node is disposed to prevent memory leaks

Histogram

this

Shape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Histogram

Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>

Histogram

this

Shape.copyConstructor

▸ disconnectStyle(style, type, callback): Histogram

Disconnect style <br> This convenience method un-subscribes a listener to given style for the specified type.<br>

Histogram

this

Shape.disconnectStyle

▸ dispose(): void

Disposes this node, once disposes a node should not be used anymore.<br> Clear all listeners, and disconnect styles to avoid memory leaks.<br> Also aggressively 'cleanup' this node by setting some of its members to null.

void

Shape.dispose

▸ enableEventPropagation(enable): Histogram

Enable event propagation from the node hierarchy from bottom to top <p> This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance. </p>

Example

import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

Histogram

this

Shape.enableEventPropagation

▸ execute(delegate): Histogram

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> and we do not need to scroll up or down in IDE to find how and where it was initialized.

Example

// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});

Histogram

The result if any or this

Shape.execute

▸ execute<T&gt;(delegate): T

T

Shape.execute

▸ Protected filter(context): boolean

Filter node

boolean

flag filter flag ("true" to render node; "false" otherwise)

Shape.filter

▸ getAccumulatedMode(): AccumulatedMode

Gets accumulated mode

AccumulatedMode

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Shape.getAnimationStyle

▸ getAutoGradient(): boolean

Gets if we are auto gradient

boolean

▸ getBinAt(x, excludeGaps?): Bin & { indices?: number[] }

Gets the bin at the input x value

Bin & { indices?: number[] }

• bin at input x value

▸ getBinCount(): number

Return bin count

number

a count of bins

▸ getBinSpacing(): number

Gets percentage of fill

number

▸ getBins(): Bin[]

Gets the values of the bins in the following array format Array [{ 'minvalue' : number, 'maxvalue' : number, 'binnumber' : number, 'frequency' : number }, ...]

Bin[]

Array of bins objects

▸ getBinsAt(x): Bin[]

Gets the bin at the input x value

Bin[]

Array of bins objects

▸ getBinsByIndices(indices): number[]

Returns bin numbers for specified indices

number[]

▸ getBounds(): Rect

Returns current bounds

Rect

bounds

▸ getClassName(): string

string

Shape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Shape.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial.

Transformation

▸ getCss(): CssStyle

Return CSS style

CssStyle

Shape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Shape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Shape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Shape.getCssTransform

▸ getData(): Object

get raw data

Object

▸ getDataSource(): number[] | NumericalDataSeries | NumericalDataSeriesView

Return histogram data source

number[] | NumericalDataSeries | NumericalDataSeriesView

data source

▸ getDisplayUnit(): AbstractUnit

get displayed unit

AbstractUnit

unit

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Shape.getFillStyle

▸ getFrequency(index, ignoreMode?): number

Gets the frequency for the current index

number

▸ getFrequencyType(): FrequencyType

Gets frequency type

FrequencyType

▸ getHighValueInclusive(): boolean

gets if the high value is inclusive

boolean

▸ getHighlightStyle(): FillStyle

Gets highlight style

FillStyle

▸ getHighlightedBins(): number[]

get highlighted bins

number[]

bins number array

▸ getHistogramMode(): HistogramMode

Gets the histogram mode

HistogramMode

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Shape.getId

▸ getIndicesByBin(index): number[]

Gets indices by bin number

number[]

of indices

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher&gt;

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

Shape.getInvalidateMethod

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Shape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Shape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number&gt;

Return margins style

SpaceStyle<string | number&gt;

Shape.getMarginsStyle

▸ getMaxFrequency(): number

Maximum frequency

number

▸ getMaxValue(): number

Get highest value to be displayed

number

_maxValue

▸ getMinValue(): number

Get lowest value to be displayed

number

_minValue

▸ getModelLimits(): Rect

Gets model limits

Rect

the current model limits

▸ getName(): string

Returns the node name

string

The node name

Shape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Shape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Shape.getOpacityBlendMode

▸ getOptions(): OptionsBaseOut

OptionsBaseOut

▸ getOrientation(): Orientation

get orientation

Orientation

▸ getParent(): Node

Return parent node

Node

parent node

Shape.getParent

▸ getProperties(): OptionsOut

Returns shape properties

OptionsOut

object

Shape.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

Shape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Shape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Shape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Shape.getResponsiveStyle

▸ getRoot(): Node

Returns root node. <br> If node doesn't have parent then it returns itself.

Node

the root node

Shape.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Shape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Shape.getSceneTransform

▸ getStartValue(): number

Gets log start value

number

▸ getStatistics(): number[]

Returns calculated statistics of values see description Histogram.getStatisticsDescription

Example

- Data samples count
- min sample value
- max sample value
- average value
- variance value
- average deviation value
- standard deviation value
- skewness value
- standard kurtosis value
- Theoretical P10 value (centile)
- Theoretical P50 value (centile)
- Theoretical P90 value (centile)

number[]

statistics

▸ getStatisticsDescription(): string[]

Descriptions of statistics

Example

return ["Sample Count", "Min", "Max", "Average", "Variance", "Avg. Deviation", "Std. Deviation", "Skewness", "Kurtosis", "P10", "P50", "P90"]

string[]

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Shape.getTag

▸ getVerticalScaling(): number

Gets vertical scale

number

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Shape.getVisible

▸ getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Transformation

transform the world transform.

Shape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Shape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Shape.hasCssClass

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

Shape.hasEventListener

▸ highlightBins(bins, reset?): void

Highlight Bins

void

▸ hitTest(hitArea): HitTestResult

Get hit bins

HitTestResult

selected bins array

▸ hitTest(hitArea, radius?): HitTestResult

Get hit bins

HitTestResult

selected bins array

▸ hitTest(hitArea, bins): HitTestResult

Get hit bins

HitTestResult

selected bins number array

▸ hitTest(hitArea, bins): HitTestResult

Get hit bins

HitTestResult

selected bins number array

▸ invalidate(bounds?, force?): Histogram

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

Histogram

this

Shape.invalidate

▸ invalidateParent(bounds?, force?): Histogram

Invalidate bounds

Histogram

this

Shape.invalidateParent

▸ isAutoBinCount(): boolean

boolean

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Shape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Shape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Shape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Shape.isSelectable

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

Shape.isSilent

▸ notify<E&gt;(type, source, args?): Histogram

Notify listeners of the Node

Histogram

this

Shape.notify

▸ off<E&gt;(type?, callback?): Histogram

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

Histogram

this

Shape.off

▸ on<E&gt;(type, callback): Histogram

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>

Histogram

this

Shape.on

▸ Protected onParentChanged(node): Histogram

This method is called when parent changes. Do not call it directly.

Histogram

this

Shape.onParentChanged

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

Shape.onVisibilityChanged

▸ Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

void

Shape.postRendering

▸ Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

void

Shape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Shape.registerAnimationStyle

▸ removeCssClass(cssclass): Histogram

Removes css class from node

Histogram

this

Shape.removeCssClass

▸ removeInvalidateHandler(handler): Histogram

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Histogram

this

Shape.removeInvalidateHandler

▸ render(context): void

Renders node

void

Shape.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

void

Shape.renderAsync

▸ resetBinCount(): void

Resets the bin count

void

▸ resetValues(): void

Resets the highest and lowest values to be computed values

void

▸ rotate(theta, x, y): Histogram

Rotate bounds around a given coordinate

Histogram

this

Shape.rotate

▸ scale(xx, yy): Histogram

Scale node

Histogram

this

Shape.scale

▸ setAccumulatedMode(accumulatedMode): Histogram

Sets accumulated mode

Histogram

▸ setAnimationStyle(animationStyle): Histogram

Sets animation style

Histogram

Shape.setAnimationStyle

▸ setAutoGradient(isAutoGradient): Histogram

Histogram

▸ setBinCount(binCount): Histogram

Sets bin count.

Histogram

▸ setBinSpacing(percentage): Histogram

Sets percentage of fill Everything lower than 50 is set to 50 Everything higher than 100 is set to 100 All values in between are saved as is

Histogram

▸ setBinSteps(binStep): Histogram

Sets bin count using a step value

Histogram

▸ setBounds(bounds): Histogram

Sets bounds of the node in the parent coordinates

Histogram

this

▸ setClipStyle(style): Histogram

Sets a new clipping style

Histogram

this

Shape.setClipStyle

▸ setCss(style, merge?): Histogram

Sets CSS style. This style will be applied for all inserted elements

Histogram

this

Shape.setCss

▸ setCssClass(name): Histogram

Sets css class name of the node to be used to apply CSS style

Histogram

this

Shape.setCssClass

▸ setCssTransform(transform): Histogram

Set CSS transformation

Histogram

this

Shape.setCssTransform

▸ setData(values, minValue?, maxValue?): Histogram

Set the data to be plotted in the histogram, optionally with min and max values.

Histogram

this

▸ setFillStyle(fillStyle, merge?): Histogram

Sets fill style

Histogram

this

Shape.setFillStyle

▸ setFrequencyType(frequencyType): Histogram

Sets frequency type

Histogram

▸ setHighLightStyles(styles): Histogram

Histogram

▸ setHighValueInclusive(inclusive): Histogram

sets if the high value is inclusive

Histogram

▸ setHighlightStyle(fillStyle): Histogram

Sets highlight style

Histogram

▸ setHistogramMode(histogramMode): Histogram

Sets histogram mode

Histogram

▸ setId(id): Histogram

Allows the user to associate any identifier

Histogram

this

Shape.setId

▸ setLineStyle(lineStyle, merge?): Histogram

Sets line style

Histogram

this

Shape.setLineStyle

▸ setLocalTransform(localTransform, force?): Histogram

Sets local transformation to be used to transform from local to parent coordinate

Histogram

this

Shape.setLocalTransform

▸ setLogStartValue(logStartValue): Histogram

Sets log start value

Histogram

this

▸ setMarginsStyle(margins, merge?): Histogram

Sets margins style

Histogram

this

Shape.setMarginsStyle

▸ setName(name): Histogram

Sets name of the node

Histogram

this

Shape.setName

▸ setNeatLimitsX(neatlimits): Histogram

set neat limits for x axis

Histogram

this

▸ setNeatLimitsY(neatlimits): Histogram

set neat limits for y axis

Histogram

this

▸ setNotification(notify, force?): Histogram

set notification state

Histogram

this

Shape.setNotification

▸ setOpacity(opacity, blendMode?): Histogram

Sets node opacity

Histogram

this

Shape.setOpacity

▸ setOptions(options): Histogram

Histogram

▸ setOrientation(orientation): Histogram

set orientation

Histogram

▸ setParent(parent): Histogram

Sets parent node. Don't call this method directly. It is internal method.

Histogram

this

Shape.setParent

▸ setProperties(properties?): Histogram

set shape properties

Histogram

this

Shape.setProperties

▸ setProperty(name, value): Histogram

Sets dynamic property by name

Histogram

this

Shape.setProperty

▸ setRenderingFilter(filter): Histogram

Sets filter to be applied before rendering and picking

Histogram

this

Shape.setRenderingFilter

▸ setResponsiveStyle(style): Histogram

Sets responsive style.

Histogram

this

Shape.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): Histogram

Sets scale scroll strategy

Histogram

this

Shape.setScaleScrollStrategy

▸ setSelectable(selectable): Histogram

Allows to select node. If node is not selectable then child node is not selectable.

Histogram

this

Shape.setSelectable

▸ setSilent(bool): Histogram

Set silent mode

Histogram