API / geotoolkit / widgets / MultiHistograms / MultiHistograms
widgets.MultiHistograms.MultiHistograms
NOTE: will be deprecated in future version, for new projects geotoolkit/charts/widgets/ChartWidget should be used instead
The multihistograms widget is a container to wrap multiple histograms into one widget and mange axes, selection and model limits for different histograms. see more details about initialization of widget in constructor of geotoolkit.widgets.AnnotatedWidget
Example
import {MultiHistograms} from '@int/geotoolkit/widgets/MultiHistograms';
import {Rect} from '@int/geotoolkit/util/Rect';
import {KnownColors} from '@int/geotoolkit/util/ColorUtil';
import {FrequencyType, HistogramMode} from '@int/geotoolkit/controls/shapes/Histogram';
function newHistogramShapeOptions (color, binNumber, name) {
return {
'name': name,
'bins': binNumber,
'frequencytype': FrequencyType.Absolute,
'histogrammode': HistogramMode.Linear,
'fillstyle': color,
'linestyle': KnownColors.Gray,
'binspacing': 100,
'unit': 'ft'
};
}
const widget = new MultiHistograms({
'bounds': new Rect(0, 0, 800, 400),
'viewcache': true,
'annotationssizes': {
'north': 20
},
'tools': {
'verticalscroll': {
'visible': false
},
'horizontalscroll': {
'visible': false
}
},
'autoannotationsize': true
});
const hist1Options = newHistogramShapeOptions(KnownColors.Blue, 20, 'series 1');
const hist2Options = newHistogramShapeOptions(KnownColors.Green, 25, 'series 2');
const hist1 = widget.addHistogram(hist1Options)
.setData(datasource1);
const hist2 = widget.addHistogram(hist2Options)
.setData(datasource2);↳
MultiHistograms
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
annotationsgaps | GapsOptions | Options for setting gaps between annotations and center model |
annotationsgaps-east | number | Desired width for axis in east annotation |
annotationsgaps-south | number | Desired height for axis in south annotation |
annotationsgaps-west | number | Desired width for axis in west annotation |
autoannotationsize | boolean | Auto modify the size of annotation based on the total size of component in the annotation |
axisheight | number | Default height when adding new horizontal axis |
axiswidth | number | Default width when adding new vertical axis |
header | HeaderOptions | Options for setting header of widget |
header-title | Options | Object to describe the properties for header text.For details, see setProperties method of |
header-title-cssclass | string | The css class name of this node |
header-title-id | string | number | Id of the node, its a unique identifier |
header-title-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
header-title-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
header-title-tag | any | Custom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape |
header-title-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
header-title-z-index | number | Define node z-index |
header-title | Options | Object to describe the properties for header text.For details, see setProperties method of |
header-title-clipstyle | ClipStyle | Clipping style |
header-title-clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
header-title-clipstyle-geometry | GraphicsPath | Clipping geometry |
header-title-clipstyle-geometry-bounds | Rect | Bounds |
header-title-clipstyle-geometry-bounds-height | number | Height |
header-title-clipstyle-geometry-bounds-readonly | boolean | Readonly |
header-title-clipstyle-geometry-bounds-width | number | Width |
header-title-clipstyle-geometry-bounds-x | number | Left |
header-title-clipstyle-geometry-bounds-y | number | Top |
header-title-clipstyle | GraphicsPath | Clipping style |
header-title-csscursor | string | CSS cursor associated with node |
header-title-cssstyle | string | CSS style to be applied to inserted elements |
header-title-localtransform | Transformation | Local transformation |
header-title-localtransform-dx | number | X axis translation |
header-title-localtransform-dy | number | Y axis translation |
header-title-localtransform-xx | number | X scale |
header-title-localtransform-xy | number | Xy skew |
header-title-localtransform-yx | number | Yx skew |
header-title-localtransform-yy | number | Y scale |
header-title-margins | number | string | It has properties for specifying the margins for each side |
header-title-opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
header-title-opacityblendmode | BlendMode | Node opacity mode to blend it |
header-title-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
header-title-scalescrollstrategy-enabled | boolean | Enable flag |
header-title-transform | string | Additional CSS transformation applied to node or 'none' |
header-title-transform | Transformation | Additional CSS transformation applied to node or 'none' |
header-title | Options | Object to describe the properties for header text.For details, see setProperties method of |
header-title-fillstyle | string | Style applied on fill |
header-title-fillstyle | FillStyle | Style applied on fill |
header-title-fillstyle-color | string | Color in CSS form |
header-title-fillstyle-evenoddmode | boolean | Even-odd fill mode |
header-title-fillstyle-fillpattern | Pattern | Pattern |
header-title-fillstyle-fillpattern-containername | string | An optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself |
header-title-fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
header-title-fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
header-title-fillstyle-foreground | string | Foreground color |
header-title-fillstyle-pattern | Pattern | Pattern |
header-title-linestyle | string | Style applied on outline |
header-title-linestyle | LineStyle | Style applied on outline |
header-title-linestyle-color | string | Color in CSS form |
header-title-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
header-title-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
header-title-linestyle-linecap | CapStyle | The line cap style |
header-title-linestyle-linedashoffset | number | Line dash offset of dashed line |
header-title-linestyle-linejoin | JoinStyle | The line join style |
header-title-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
header-title-linestyle-scalable | boolean | True if width should depend on transformation |
header-title-linestyle-unit | string | Optional unit for the width |
header-title-linestyle-width | number | string | The line thickness |
header-title | Options | Object to describe the properties for header text.For details, see setProperties method of |
header-title-alignment | AnchorType | Alignment according to the anchor point |
header-title-ax | number | Anchor x position |
header-title-ay | number | Anchor y position |
header-title-height | number | Shape height |
header-title-ispointingup | boolean | Defines whether the shape is always pointing up |
header-title-layoutstyle | LayoutStyle | Layout style to specify how to lay out shape |
header-title-layoutstyle-constraint | SizeConstraint | Layout constrains |
header-title-layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
header-title-layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
header-title-layoutstyle-float | string | Float position |
header-title-layoutstyle-position | string | Layout position |
header-title-layoutstyle-size | number | string | Layout size |
header-title-maxdimension | Dimension | Maximum size for rendering |
header-title-maxdimension-height | number | Height of dimension |
header-title-maxdimension-width | number | Width of dimension or properties |
header-title-mindimension | Dimension | Minimum size for rendering |
header-title-preserveaspectratio | boolean | Preserve aspect ratio of the anchored shape |
header-title-preservereadingorientation | boolean | Preserve reading orientation for local transform |
header-title-preserverightangle | boolean | Preserve right angle for local transformation |
header-title-rotationangle | number | Rotation angle at anchor |
header-title-sizeisindevicespace | boolean | Is coordinate in device space |
header-title-useminmaxdimensions | boolean | Use the min max dimensions to limit visual size |
header-title-width | number | Shape width |
header-title | Options | Object to describe the properties for header text.For details, see setProperties method of |
header-title-autosize | boolean | Automatically fit shape bounds to text size, default is true Set it to false if you have more than one paragraph inside with different alignment |
header-title-ellipsisstring | string | String ellipsis that renders if ellipsis is true |
header-title-padding | number | |
header-title-paddingstyle | number | string | Inner padding style in device coordinates |
header-title-radius | number | Border radius in device coordinates |
header-title-showellipsis | boolean | Ellipsis flag |
header-title-sizemode | SizeMode | Text size mode, default value depends on width and height settings |
header-title-text | string | Text to display |
header-title-textstyle | string | TextStyle to display |
header-title-textstyle | TextStyle | TextStyle to display |
header-title-textstyle-alignment | AlignmentStyle | Alignment |
header-title-textstyle-autosize | boolean | Auto font size on high definition display |
header-title-textstyle-background | string | Background style |
header-title-textstyle-background | FillStyle | Background style |
header-title-textstyle-baseline | BaseLineStyle | Base line |
header-title-textstyle-color | string | Color in CSS form |
header-title-textstyle-fill | FillStyle | Text fill style |
header-title-textstyle-font | string | Font see |
header-title-textstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
header-title-textstyle-lineheight | string | number | Line height |
header-title-textstyle-multiline | boolean | Allow multi-line text |
header-title-textstyle-outline | string | Outline style |
header-title-textstyle-outline | LineStyle | Outline style |
header-title-textstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
header-title-textstyle-strikethrough | string | Strikethrough style |
header-title-textstyle-strikethrough | LineStyle | Strikethrough style |
header-title-textstyle-textoverflow | TextOverflowStyle | Text overflow |
header-title-textstyle-underline | string | Underline style |
header-title-textstyle-underline | LineStyle | Underline style |
header-title-textstyle-underlineoffset | string | number | Underline offset distance |
header-title-textstyle-whitespace | WhiteSpaceStyle | White space |
header-title-textstyle-wordbreak | WordBreakStyle | Word break |
header-title-texttransform | Transform | Text-transform (uppercase, lowercase, capitalize) |
header-title-userheight | number | Height |
header-title-userwidth | number | Width |
tools | ToolsOptions | Options for tools setting, see details in setToolsOptions method |
tools-crosshair | Options | JSON which defines crosshair cursor. See |
tools-crosshair-enabled | boolean | Enabled state |
tools-crosshair-layer | CompositeNode | Manipulator layer |
tools-crosshair-layer-clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
tools-crosshair-layer-clipstyle | ClipStyle | Clipping style |
tools-crosshair-layer-clipstyle | GraphicsPath | Clipping style |
tools-crosshair-layer-cssclass | string | The css class name of this node |
tools-crosshair-layer-csscursor | string | CSS cursor associated with node |
tools-crosshair-layer-cssstyle | string | CSS style to be applied to inserted elements |
tools-crosshair-layer-id | string | number | Id of the node, its a unique identifier |
tools-crosshair-layer-infinity | boolean | Mode to render outside the model limits |
tools-crosshair-layer-localtransform | Transformation | Local transformation |
tools-crosshair-layer-margins | number | string | It has properties for specifying the margins for each side |
tools-crosshair-layer-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
tools-crosshair-layer-opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
tools-crosshair-layer-opacityblendmode | BlendMode | Node opacity mode to blend it |
tools-crosshair-layer-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
tools-crosshair-layer-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
tools-crosshair-layer-tag | any | Custom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape |
tools-crosshair-layer-transform | string | Additional CSS transformation applied to node or 'none' |
tools-crosshair-layer-transform | Transformation | Additional CSS transformation applied to node or 'none' |
tools-crosshair-layer-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
tools-crosshair-layer-z-index | number | Define node z-index |
tools-crosshair-mouseradius | number | Device radius for mouse events |
tools-crosshair-name | string | Name of the tool used like cross-hair etc |
tools-crosshair-touchradius | number | Device radius for touch events |
tools-crosshair | Options | JSON which defines crosshair cursor. See |
tools-crosshair-east | LabelSettings | JSON for east label. See setLabelSettings for more details |
tools-crosshair-east-alignment | AnchorType | Alignment of the text |
tools-crosshair-east-cssclass | string | The css class name of this node |
tools-crosshair-east-displaymode | LabelDisplayMode | Label display mode, default is LabelDisplayMode.Shape |
tools-crosshair-east-fillstyle | string | Fill style of the text |
tools-crosshair-east-fillstyle | FillStyle | Fill style of the text |
tools-crosshair-east-linestyle | string | Line style of the text border |
tools-crosshair-east-linestyle | LineStyle | Line style of the text border |
tools-crosshair-east-offset | number | string | Label offset between the text and cross-hair cursor, use padding in case of undefined |
tools-crosshair-east-padding | number | |
tools-crosshair-east-paddingstyle | number | string | Padding style between the text and the border |
tools-crosshair-east-radius | number | Radius of the text shape border |
tools-crosshair-east-textstyle | string | Text style of the text |
tools-crosshair-east-textstyle | TextStyle | Text style of the text |
tools-crosshair-east-tooltip | Properties | Tooltip properties, this options applyes only in case if displaymode:LabelDisplayMode.DivElement |
tools-crosshair-east-tooltip-alignment | AnchorType | Tooltip alignment according to the point set by offsets |
tools-crosshair-east-tooltip-autoflip | boolean | True to automatically flip tooltip alignment if it doesn't fit the window |
tools-crosshair-east-tooltip-cssclasses | string | CSS classes' names to be applied for tooltip 'cg-tooltip' by default |
tools-crosshair-east-tooltip-delay | number | |
tools-crosshair-east-tooltip-hidedelay | number | Auto hide in millisecond, 0 means false and autohide is disabled |
tools-crosshair-east-tooltip-offsetx | number | Offset of tooltip from current position by x in pixels |
tools-crosshair-east-tooltip-offsety | number | Offset of tooltip from current position by y in pixels |
tools-crosshair-east-tooltip-orientation | Orientation | Tooltip orientation |
tools-crosshair-east-tooltip-showdelay | number | Delay between displaying tooltip, 0 means false and tooltip shows immediately |
tools-crosshair-east-tooltip-size | Range | Client size range |
tools-crosshair-east-tooltip-size-high | number | Upper range boundary |
tools-crosshair-east-tooltip-size-low | number | Lower range boundary |
tools-crosshair-east-tooltip-size-max | number | |
tools-crosshair-east-tooltip-size-min | number | |
tools-crosshair-east-visible | boolean | Visibility of the text |
tools-crosshair-east-z-index | number | Define node z-index |
tools-crosshair-fillstyle | string | Fillstyle of the cross-hair (used only with radius) |
tools-crosshair-fillstyle | FillStyle | Fillstyle of the cross-hair (used only with radius) |
tools-crosshair-horizontal | string | Linestyle for horizontal line |
tools-crosshair-horizontal | LineStyle | Linestyle for horizontal line |
tools-crosshair-keeporientation | boolean | Preserve annotation's orientation of labels for different |
tools-crosshair-labels | boolean | If 'none' of false - do not create labels |
tools-crosshair-linestyle | string |
|
tools-crosshair-linestyle | LineStyle |
|
tools-crosshair-north | LabelSettings | JSON for north label. See setLabelSettings for more details |
tools-crosshair-outlinestyle | string | OutLinestyle for both lines |
tools-crosshair-outlinestyle | LineStyle | OutLinestyle for both lines |
tools-crosshair-radius | number | Radius of the cross-hair center target |
tools-crosshair-south | LabelSettings | JSON for south label. See setLabelSettings for more details |
tools-crosshair-symbol | SymbolShape | Symbol of the cross-hair |
tools-crosshair-symbol-alignment | AnchorType | Alignment according to the anchor point |
tools-crosshair-symbol-alignment | AnchorType | Anchor type of symbol |
tools-crosshair-symbol-ax | number | Anchor x position |
tools-crosshair-symbol-ay | number | Anchor y position |
tools-crosshair-symbol-cache | boolean | Set it to true if you want to cache complex geometry to raster |
tools-crosshair-symbol-clipstyle | ClipStyle | Clipping style |
tools-crosshair-symbol-clipstyle | GraphicsPath | Clipping style |
tools-crosshair-symbol-cssclass | string | The css class name of this node |
tools-crosshair-symbol-csscursor | string | CSS cursor associated with node |
tools-crosshair-symbol-cssstyle | string | CSS style to be applied to inserted elements |
tools-crosshair-symbol-fillstyle | string | Style applied on fill |
tools-crosshair-symbol-fillstyle | FillStyle | Style applied on fill |
tools-crosshair-symbol-height | number | Shape height |
tools-crosshair-symbol-id | string | number | Id of the node, its a unique identifier |
tools-crosshair-symbol-ispointingup | boolean | Defines whether the shape is always pointing up |
tools-crosshair-symbol-layoutstyle | LayoutStyle | Layout style to specify how to lay out shape |
tools-crosshair-symbol-linestyle | string | Style applied on outline |
tools-crosshair-symbol-linestyle | LineStyle | Style applied on outline |
tools-crosshair-symbol-localtransform | Transformation | Local transformation |
tools-crosshair-symbol-margins | number | string | It has properties for specifying the margins for each side |
tools-crosshair-symbol-maxdimension | Dimension | Maximum size for rendering |
tools-crosshair-symbol-mindimension | Dimension | Minimum size for rendering |
tools-crosshair-symbol-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
tools-crosshair-symbol-opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
tools-crosshair-symbol-opacityblendmode | BlendMode | Node opacity mode to blend it |
tools-crosshair-symbol-painter | string | A function with has parameters: symbol, box, context |
tools-crosshair-symbol-painterproperties | any | Symbol's painter's properties |
tools-crosshair-symbol-preserveaspectratio | boolean | Preserve aspect ratio of the anchored shape |
tools-crosshair-symbol-preservereadingorientation | boolean | Preserve reading orientation for local transform |
tools-crosshair-symbol-preserverightangle | boolean | Preserve right angle for local transformation |
tools-crosshair-symbol-rotationangle | number | Rotation angle at anchor |
tools-crosshair-symbol-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
tools-crosshair-symbol-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
tools-crosshair-symbol-sizeisindevicespace | boolean | Is coordinate in device space |
tools-crosshair-symbol-tag | any | Custom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape |
tools-crosshair-symbol-transform | string | Additional CSS transformation applied to node or 'none' |
tools-crosshair-symbol-transform | Transformation | Additional CSS transformation applied to node or 'none' |
tools-crosshair-symbol-useminmaxdimensions | boolean | Use the min max dimensions to limit visual size |
tools-crosshair-symbol-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
tools-crosshair-symbol-width | number | Shape width |
tools-crosshair-symbol-z-index | number | Define node z-index |
tools-crosshair-textstyle | string |
|
tools-crosshair-textstyle | TextStyle |
|
tools-crosshair-vertical | string | Linestyle for vertical line |
tools-crosshair-vertical | LineStyle | Linestyle for vertical line |
tools-crosshair-west | LabelSettings | JSON for west label. See setLabelSettings for more details |
tools-horizontalscroll | ScrollBarOptions | Horizontal scroll bar options |
tools-horizontalscroll-enabled | boolean | |
tools-horizontalscroll-name | string | |
tools-panning | Options | JSON which defines panning tool. See |
tools-panning | Options | JSON which defines panning tool. See |
tools-panning-acceptx | boolean | Accept x coordinates |
tools-panning-inertiacoef | number | boolean | Inertia coefficient for inertia effect |
tools-panning-panningthreshold | number | Threshold to prevent panning. If user pointer movement is under this value the panning will be ignore. WARNING: if you set positive inertia coefficient, some panning events'll be fired with null eventArgs |
tools-panning-wheelratio | number | Number that represent the number default |
tools-rubberbandzoom | Options | JSON which defines rubber band zoom. See |
tools-rubberbandzoom | Options | JSON which defines rubber band zoom. See |
tools-rubberbandzoom-mode | RubberBandRenderMode | Rubber mode |
tools-rubberbandzoom | Options | JSON which defines rubber band zoom. See |
tools-rubberbandzoom-acceptemptyrect | boolean | Does rubber band accept empty rect |
tools-rubberbandzoom-autodisabled | boolean | Does rubber band automatically disabled on zoom end |
tools-rubberbandzoom-fillstyle | string | Rubber band fillstyle |
tools-rubberbandzoom-fillstyle | FillStyle | Rubber band fillstyle |
tools-rubberbandzoom-linestyle | string | Rubber band linestyle |
tools-rubberbandzoom-linestyle | LineStyle | Rubber band linestyle |
tools-rubberbandzoom-restrictionarea | Rect | Specify restriction area |
tools-verticalscroll | ScrollBarOptions | Vertical scroll bar options |
tools-zoom | Options | JSON which defines zoom. See |
tools-zoom | Options | JSON which defines zoom. See |
tools-zoom-easing | Functions | Easing animation function for elastic zooming |
tools-zoom-max | number | Maximum limits for zooming (>= options.zoom.min) |
tools-zoom-min | number | Minimum limits for zooming (>= 0) |
tools-zoom-mode | Mode | Mode of pinch zooming |
tools-zoom-modifier | ModifierKey | Modifier key for zoom, default is ModifierKey.None |
tools-zoom-speed | number | Speed of zooming (>= 1) |
tools-zoom-time | number | Zooming time in ms (> 0 for elastic, 0 for instant) |
tools | ToolsOptions | Options for tools setting, see details in setToolsOptions method |
tools-axisselection | AxisSelectionOptions | Options for set up selection on axis, see details in setAxisSelection method |
tools-axisselection-enabled | boolean | Flag to enable axis selection |
tools-axisselection-highlightstyle | string | Fillstyle for background of axis |
tools-axisselection-highlightstyle | FillStyle | Fillstyle for background of axis |
tools-southscroll | ScrollBarOptions | Options for set up vertical scroll bar for south annotation, see details in setAnnotationsScrollBar method |
tools-southscroll-options | Options | Properties for setting scroll bar |
tools-southscroll-options | Options | Properties for setting scroll bar |
tools-southscroll-options | Options | Properties for setting scroll bar |
tools-southscroll-options-clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
tools-southscroll-options-infinity | boolean | Mode to render outside the model limits |
tools-southscroll-options | Options | Properties for setting scroll bar |
tools-southscroll-options-automodellimitsmode | boolean | Auto model limits mode |
tools-southscroll-options-bounds | Rect | Define position of the group in the parent |
tools-southscroll-options-contentorientation | Orientation | Content orientation |
tools-southscroll-options-fillstyle | string | Fill style |
tools-southscroll-options-fillstyle | FillStyle | Fill style |
tools-southscroll-options-horizontalflip | boolean | Horizontal axis goes from right to left |
tools-southscroll-options-layoutstyle | LayoutStyle | Layout style to be used for parent layout |
tools-southscroll-options-linestyle | string | Line style |
tools-southscroll-options-linestyle | LineStyle | Line style |
tools-southscroll-options-modellimits | Rect | Define inner model coordinates of the group |
tools-southscroll-options-padding | number | string | It has properties for specifying the padding for each side |
tools-southscroll-options-pickingchildren | boolean | Enable picking children |
tools-southscroll-options-verticalflip | boolean | Vertical axis goes from bottom to top |
tools-southscroll-options-viewcache | boolean | View cache to cache child nodes |
tools-southscroll-options | Options | Properties for setting scroll bar |
tools-southscroll-options-backgroundfillstyle | string | Background fill style |
tools-southscroll-options-backgroundfillstyle | FillStyle | Background fill style |
tools-southscroll-options-floating | boolean | Flag to set floating mode |
tools-southscroll-options-size | number | Desired size |
tools-southscroll-options-transparency | number | Alpha |
tools-southscroll-size | number | Height for horizontal scroll bar or width for vertical scroll bar |
tools-southscroll-visible | boolean | Flag to set visibility of scroll bar |
viewcache | boolean | If set viewcache for the widget |
Constructors
• new MultiHistograms(options?)
| Name | Type |
|---|---|
Optional options | Options |
AnnotatedWidget.constructor
Methods
▸ addAxis(axis, location, connectedObject?): Object
add new axis and connect with object
| Name | Type | Description |
|---|---|---|
axis | Axis | AxisOptions | new axis instance or options |
location | AnnotationLocation | location of annotation for adding new axis |
Optional connectedObject | Group<Node> | connected object of axis |
Object
▸ addAxisTo(location, options, connectedObject?): void
create new axis with options, adding and connect it with object
| Name | Type | Description |
|---|---|---|
location | AnnotationLocation | location of annotation for adding new axis |
options | GroupAxisOptions | options |
Optional connectedObject | string | Node | Histogram | connected object of axis |
void
▸ addBaseLayer(baseLayer): MultiHistograms
Add baseLayer to container
this
▸ addChild(node): MultiHistograms
Add a child node
this
▸ addCssClass(cssclass): MultiHistograms
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addHistogram(options, axes?, id?): Histogram
create a new histogram with axes
| Name | Type | Description |
|---|---|---|
options | Options | options to set up histogram shape |
Optional axes | AddHistogramAxes | axes options |
Optional id | string | id for identifying histogram and axis |
[histObj.histogram] returned shape
▸ addHistogramsToGroup(shapes, groupRef): MultiHistograms
add histograms to an existing group as new members
| Name | Type | Description |
|---|---|---|
shapes | string | string[] | Histogram | Histogram[] | array of histograms or their id |
groupRef | string | Group | id string or object that contain groupid property |
▸ addInvalidateHandler(handler): MultiHistograms
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AnnotatedWidget.addInvalidateHandler
▸ addLegend(options): LegendPanel
Creates legend, scrollable panel and interactive tools for the options provided. If legend already exists, does nothing.
Example
widget.addLegend({
// use known types to create legend items automatically (from charts)
// use custom string item for user setup
'alignment': AnchorType.LeftTop,
'offset': new Point(60, 40)
});| Name | Type | Description |
|---|---|---|
options | LegendOptions | LegendPanel | legend options |
▸ Protected addLegendInteral(options): LegendPanel
| Name | Type |
|---|---|
options | LegendOptions | LegendPanel |
AnnotatedWidget.addLegendInteral
▸ addOverlay(overlay): MultiHistograms
Add overlay to container
this
▸ addTitle(location, options): void
Add title to annotation
| Name | Type | Description |
|---|---|---|
location | AnnotationLocation | of the title |
options | TitleOptions | title options |
void
▸ adjustPosition(area?, vAlign?, hAlign?): MultiHistograms
Adjust position of node to specified area
| Name | Type | Description |
|---|---|---|
Optional area | Rect | specified area. Default to Parent Model Limits |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". Defaults to "top". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". Defaults to "left". |
this
AnnotatedWidget.adjustPosition
▸ Protected applyOpacity(context): MultiHistograms
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
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
AnnotatedWidget.applyResponsiveStyle
▸ beginExport(): MultiHistograms
Prepares object before exporting and saving state
▸ changeBaseLayerOrder(overlay, order, anchor?): MultiHistograms
Changes the z-order of the baseLayer.
| Name | Type | Description |
|---|---|---|
overlay | Node | |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
AnnotatedWidget.changeBaseLayerOrder
▸ changeChildOrder(node, order, anchor?): MultiHistograms
changes the z-order of the nodes being rendered.
| Name | Type | Description |
|---|---|---|
node | Node | any child added in the Composite node |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
AnnotatedWidget.changeChildOrder
▸ changeOverlayOrder(overlay, order, anchor?): MultiHistograms
Changes the z-order of the overlay.
| Name | Type | Description |
|---|---|---|
overlay | Node | child overlay |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
AnnotatedWidget.changeOverlayOrder
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if node is collided
AnnotatedWidget.checkCollision
▸ clearBaseLayers(disposeBaseLayers?): MultiHistograms
Remove all child baseLayers from group
| Name | Type | Description |
|---|---|---|
Optional disposeBaseLayers | boolean | automatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default |
this
AnnotatedWidget.clearBaseLayers
▸ clearCache(): MultiHistograms
Clear cache
this
▸ clearChildren(disposeChildren?): MultiHistograms
Remove all child nodes from this composite group
| Name | Type | Description |
|---|---|---|
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
this
▸ clearOverlays(disposeOverlays?): MultiHistograms
Remove all child overlays from group
| Name | Type | Description |
|---|---|---|
Optional disposeOverlays | boolean | automatically dispose overlays. If it is true then method dispose is called for each overlay, false by default |
this
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connect(object, model, orientation?, autoSize?): MultiHistograms
Synchronizes object with a model
| Name | Type | Description |
|---|---|---|
object | Axis | Group<Node> | object to be synchronized |
model | Group<Node> | source model |
Optional orientation | Orientation | horizontal or vertical |
Optional autoSize | boolean | true if object and model share the same device size in the orientation, true by default if not specified |
this
▸ connectStyle(style, type, callback): MultiHistograms
Connects style.
This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ connectTool(tool): MultiHistograms
Connect a new tool with a toolname to the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool associated with the widget |
this
▸ Protected copyConstructor(src, deepCopy?): MultiHistograms
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
this
AnnotatedWidget.copyConstructor
▸ createGroup(shapes, location, axisOptions?, gid?): Group
create group in certain annotation(along certain axis) based on histograms
| Name | Type | Description |
|---|---|---|
shapes | string[] | Histogram[] | array of histograms |
location | AnnotationLocation | location of annotation that containing axis for limits group |
Optional axisOptions | GroupAxisOptions | options to set up new axis. The default value of options would be the options get from the axis of one histogram in the group. For details, see the internalAddAxis method. |
Optional gid | string | group id |
to refer to group and related object
▸ disconnect(object): MultiHistograms
Disconnect an object from its source model
this
▸ disconnectStyle(style, type, callback): MultiHistograms
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
AnnotatedWidget.disconnectStyle
▸ disconnectTool(tool): MultiHistograms
Disconnect the tool from the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool to disconnect |
this
AnnotatedWidget.disconnectTool
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
▸ Protected drawBorder(localContext, bounds?): MultiHistograms
Draws a rectangle at the bounding box (in parent coordinates)
| Name | Type | Description |
|---|---|---|
localContext | RenderingContext | The local rendering context |
Optional bounds | Rect | group bounds |
this
▸ enableClipping(doClip): MultiHistograms
Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.
| Name | Type | Description |
|---|---|---|
doClip | boolean | enable clipping on this node |
this
AnnotatedWidget.enableClipping
▸ enableEventPropagation(enable): MultiHistograms
Enable event propagation from the node hierarchy from bottom to top
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.
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();| Name | Type | Description |
|---|---|---|
enable | boolean | enable |
this
AnnotatedWidget.enableEventPropagation
▸ enablePickingChildren(enable): MultiHistograms
Enables or disables picking children
| Name | Type | Description |
|---|---|---|
enable | boolean | enable picking children |
this
AnnotatedWidget.enablePickingChildren
▸ endExport(): void
Restores object's state after exporting
void
▸ enumerateNodes(callback, target?): void
Executes a provided function once for each child node
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | provided function |
Optional target | QueryBuilder<any> | target to pass to callback as a second parameter |
void
AnnotatedWidget.enumerateNodes
▸ execute(delegate): MultiHistograms
Executes delegate and return the result. It allows us to keep all initialization calls in one place,
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");
});| Name | Type | Description |
|---|---|---|
delegate | (this: MultiHistograms) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: MultiHistograms) => T |
T
▸ exportToPdf(options?): Promise<IWritable>
Export a part of the container to PDF
This method sets automatically export scale and limits based on input parameters and current model scale and limits
| Name | Type | Description |
|---|---|---|
Optional options | ExportToPdfOptions | option to specify paper parameters and header and footer |
Promise<IWritable>
promise with output stream
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ fitToBounds(): MultiHistograms
fit bounds to model limits
Fires
Events.ModelVisibleLimitsChanged
this
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
AnnotatedWidget.getAnimationStyle
▸ getAnnotation(location): Group<Node>
return the node at the specific annotation
| Name | Type | Description |
|---|---|---|
location | AnnotationLocation | position to return the node for |
▸ getAnnotationScrollBarOptions(): OptionsOut
get scroll bar options
options south scroll bar options
▸ getAnnotationSize(): Required<AnnotationSize>
Return sizes of all annotations or the exact one
Required<AnnotationSize>
contains size of all annotations
AnnotatedWidget.getAnnotationSize
▸ getAnnotationSize(loc): string | number
| Name | Type |
|---|---|
loc | AnnotationLocation |
string | number
AnnotatedWidget.getAnnotationSize
▸ getAutoModelLimitsMode(): boolean
Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds
boolean
mode
AnnotatedWidget.getAutoModelLimitsMode
▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy
Get Model Limits Logics Strategy
strategy
AnnotatedWidget.getAutoModelLimitsStrategy
▸ getAxisOptions(ref, location): AxisOptionsOut
get axis and related group options
| Name | Type | Description |
|---|---|---|
ref | string | Histogram | Group | shape histogram reference or group reference for identifying the axis |
location | AnnotationLocation | location of the axis |
▸ getAxisSelectionOptions(): AxisSelectionOptionsOut
get axis selection options
▸ getBaseLayer(index): Node
Return baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the baseLayer for |
track
▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>
Return iterator by baseLayers nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ getBaseLayers(filter?, modify?): Iterator<Node>
Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.
Example
// Gets a writable iterator
const it = node.getOverlays(null, true);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
▸ getBaseLayersCount(): number
Returns amount of baseLayers
number
AnnotatedWidget.getBaseLayersCount
▸ getBounds(): Rect
Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.
current bounds
▸ getCache(): Cache
Return cache strategy to be used to cache children nodes
cache
▸ getCenterModelLimits(): Rect
Return model limits
annotated model limits
AnnotatedWidget.getCenterModelLimits
▸ getChild(i): Node
Return node by index
| Name | Type | Description |
|---|---|---|
i | number | index of the node |
▸ getChildren<S>(predicate, modify?): Iterator<S>
Return iterator by child nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
Iterator<S>
▸ getChildren(filter?, modify?): Iterator<Node>
Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.
Example
// Gets a writable iterator
const it = node.getChildren(null, true);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all nodes if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child nodes.
▸ getChildrenCount(): number
Return number of child nodes
number
AnnotatedWidget.getChildrenCount
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getContentOrientation(): Orientation
Return content orientation
content orientation
AnnotatedWidget.getContentOrientation
▸ getContentsArea(transformation?): Rect
Return area without paddings. Model limits are mapped to content area, where children are layout.
| Name | Type | Description |
|---|---|---|
Optional transformation | Transformation | scene transformation |
AnnotatedWidget.getContentsArea
▸ getContentsTransform(): Transformation
getContentsTransform() retrieves the world transformation of the node.
transformation from model coordinates to bounds of the group
AnnotatedWidget.getContentsTransform
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
▸ getCssTransform(): string
Returns CSS transformation
string
AnnotatedWidget.getCssTransform
▸ getData(): DataSource
returns data source
▸ getDataBinding(): DataBinding
Return the data binding
▸ getDesiredHeight(): string | number
Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()
string | number
desired height ("undefined" by default)
AnnotatedWidget.getDesiredHeight
▸ getDesiredWidth(): string | number
Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()
string | number
desired width ("undefined" by default)
AnnotatedWidget.getDesiredWidth
▸ getDeviceLimits(): Rect
Return device limits
AnnotatedWidget.getDeviceLimits
▸ getExportElement(options?): CompositeDocumentElement
Returns exportable element
| Name | Type | Description |
|---|---|---|
Optional options | ExportElementOptions | options |
return exportable element
AnnotatedWidget.getExportElement
▸ getExportLimits(): Rect
Return export limits
AnnotatedWidget.getExportLimits
▸ getExportScale(): Object
Gets export scale. By default scale is not set and equal to screen scale
Object
scale
| Name | Type | Description |
|---|---|---|
x | number | scale by x form model to device |
y | number | scale by y form model to device |
AnnotatedWidget.getExportScale
▸ Protected getExportState(): Record<string, any>
Returns export state
Record<string, any>
export state
AnnotatedWidget.getExportState
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getGroupIdByHistogram(shape): GroupId
get the id of groups which histogram belong to
| Name | Type | Description |
|---|---|---|
shape | Histogram | the histogram in the group |
group id id of groups contain the histogram
▸ getGroupModelLimits(groupRef): Rect
get the shared model limits of limits group
| Name | Type | Description |
|---|---|---|
groupRef | string | Group | id string or object that contain groupid property |
limits copy of shared model limits
▸ getGroupsId(): number[]
get all limits groupId
number[]
groups ids of all groups
▸ getHeaderOptions(): HeaderOptionsOut
get header options
header options
▸ getHighlightableHistograms(): Histogram[]
get highlightable histograms
highlightable histograms
▸ getHighlightedBins(shapes): number[][]
get selected bins in highlightable histograms
number[][]
array of bins array
▸ getHistogramModelLimits(shape): Rect
return visual(could be not real limit get from shape's getModelLimits method) model limits of histogram in widget
| Name | Type | Description |
|---|---|---|
shape | string | Histogram | histogram reference |
limits copy of visual model limits
▸ getHistograms(returnId?): number[] | Histogram[]
get all histograms
| Name | Type | Description |
|---|---|---|
Optional returnId | boolean | instead return histograms instance, return Ids of histograms |
number[] | Histogram[]
histograms all histograms in the widget
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
AnnotatedWidget.getInfiniteMode
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
AnnotatedWidget.getInvalidateMethod
▸ getLayout(): Layout
Returns layout associated with the group
layout
▸ getLayoutStyle(): LayoutStyle<string | number>
return desired layout style
LayoutStyle<string | number>
AnnotatedWidget.getLayoutStyle
▸ getLegendLayer(): Group<Node>
Returns layer to keep legend on top of widget
AnnotatedWidget.getLegendLayer
▸ getLineStyle(): LineStyle
Return border style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
AnnotatedWidget.getLocalTransform
▸ getLocationOfGroup(groupRef): AnnotationLocation
get location of limits group
| Name | Type | Description |
|---|---|---|
groupRef | string | Group | id string or object that contain groupid property |
location of group
▸ getManipulatorLayer(): CompositeNode<Node>
return manipulator layer
AnnotatedWidget.getManipulatorLayer
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
AnnotatedWidget.getMarginsStyle
get model node
▸ getModelLimits(): Rect
Gets model limits, the limits of this groups inside space
the current model limits
AnnotatedWidget.getModelLimits
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
AnnotatedWidget.getOpacityBlendMode
▸ getOverlay(index): Node
Return overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
▸ getOverlayAt(index): Node
Return overlay at specified index
Deprecated
since 4.2 use getOverlay instead
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
▸ getOverlayLayer(): Layer<Node>
Returns manipulator overlay to draw shapes that should move with the model
AnnotatedWidget.getOverlayLayer
▸ getOverlays<S>(predicate, modify?): Iterator<Node>
Return iterator by overlays nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ getOverlays(filter?, modify?): Iterator<Node>
Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.
Example
// Gets a writable iterator
const it = node.getOverlays(null, true);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
▸ getOverlaysCount(): number
Returns amount of overlays
number
AnnotatedWidget.getOverlaysCount
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
AnnotatedWidget.getPaddingStyle
▸ getParent(): Node
Return parent node
parent node
▸ getPreferredSize(): Rect
Return preferred size to layout children
AnnotatedWidget.getPreferredSize
▸ getProperties(context?): OptionsOut
Gets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional context | ISerializationContext | serialization context |
properties object
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
AnnotatedWidget.getPropertyKeys
▸ getRelatedHistogramsByGroup(groupRef, returnVisibleModel?, returnId?): Histogram[]
get histograms from bind group
| Name | Type | Description |
|---|---|---|
groupRef | string | Group | id string or object that contain groupid property |
Optional returnVisibleModel | boolean | the flag to determine if only return visible models |
Optional returnId | boolean | set if only return id of histogram instead of histogram instance |
shapes array of histograms
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
AnnotatedWidget.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
AnnotatedWidget.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets ScaleScrollStrategy ("undefined" by default)
ScaleScrollStrategy (see "setScaleScrollStrategy" description for more info)
AnnotatedWidget.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
AnnotatedWidget.getSceneTransform
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTool(): CompositeTool
Returns root tool associated to this widget
▸ getToolByName<T>(toolName): Tools[T]
Returns the tool matching the given name.
This function also accepts tool 'path' instead of absolute name.
For example:
getToolByName("compositeTool.panningTools.trackPanning.TrackPanning")
Would return the same tool as
getToolByName("TrackPanning")
As long as there is only one tool named "TrackPanning" in this composite
See listToolsNames()
| Name | Type |
|---|---|
T | extends string |
| Name | Type | Description |
|---|---|---|
toolName | T | The tool name or path |
Tools[T]
▸ getToolByType(toolType): AbstractTool
Returns the tool matching the given type. or null if nothing is matching the tool type
For example:
getToolByType(geotoolkit.controls.tools.Selection)
Would return the same tool as
getToolByName("pick")
| Name | Type | Description |
|---|---|---|
toolType | ClassType<any> | toolType of the tool |
▸ getToolsOptions(): ToolsOptionsOut
get tools options
tools options
AnnotatedWidget.getToolsOptions
▸ getUnderlayLayer(): Group<Node>
return underlay layer for add new visual under histograms
group instead get a Layer object , widget return Group object for setting model limits with ease.
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getVisibleCenterModelLimits(ignoreModelLimits?): Rect
Returns visible model limits of the center model
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore model limits or not. By default this option is false and visible limits will be intersected with center model limits |
AnnotatedWidget.getVisibleCenterModelLimits
▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect
Return visible device limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
AnnotatedWidget.getVisibleDeviceLimits
▸ getVisibleModelLimits(ignoreModelLimits?): Rect
Return visible model limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
AnnotatedWidget.getVisibleModelLimits
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
AnnotatedWidget.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
AnnotatedWidget.hasEventListener
▸ indexOfBaseLayer(baseLayer): number
Return index of overlay ( index of the specified child or -1 if baseLayer is not found)
| Name | Type | Description |
|---|---|---|
baseLayer | Node | baseLayer to check index |
number
AnnotatedWidget.indexOfBaseLayer
▸ indexOfChild(node): number
Return index of child ( index of the specified child or -1 if node is not found)
| Name | Type | Description |
|---|---|---|
node | Node | node to check index |
number
▸ indexOfOverlay(overlay): number
Return index of overlay ( index of the specified child or -1 if overlay is not found)
| Name | Type | Description |
|---|---|---|
overlay | Node | overlay to check index |
number
AnnotatedWidget.indexOfOverlay
▸ Protected initializeFloatingAnnotationTool(): FloatingAnnotationTool
AnnotatedWidget.initializeFloatingAnnotationTool
▸ initializeLayout(settings): Group<Node>
| Name | Type |
|---|---|
settings | Options |
AnnotatedWidget.initializeLayout
▸ Protected initializeTools(options?): MultiHistograms
function call in the constructor to initialize tools in the widget
This widget contains by default :
- CrossHair tool
- RubberBand tool
- Panning tool
- HorizontalScroll
- VerticalScroll
| Name | Type | Description |
|---|---|---|
Optional options | Options | tools options |
this
AnnotatedWidget.initializeTools
▸ insertAxis(axisIndex, axis, location, connectedObject?): Object
Insert new axis and connect with object
| Name | Type | Description |
|---|---|---|
axisIndex | number | desired axis index |
axis | Axis | AxisOptions | new axis instance or options |
location | AnnotationLocation | location of annotation for adding new axis |
Optional connectedObject | Group<Node> | connected object of axis |
Object
▸ insertBaseLayer(index, baseLayer): MultiHistograms
Insert child baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
baseLayer | Node | a baseLayer to add |
this
AnnotatedWidget.insertBaseLayer
▸ insertChild(index, node): MultiHistograms
Insert child node at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
node | Node | a child node to add |
this
▸ insertOverlay(index, overlay): MultiHistograms
Insert child overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
overlay | Node | a overlay to add |
this
▸ invalidate(bounds?, force?): MultiHistograms
Invalidate node
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | optional rectangular area to be invalidated, or force flag if rectangle is empty |
Optional force | boolean | optional boolean parameter that can force invalidation |
this
▸ invalidateLayout(propagate?): MultiHistograms
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
AnnotatedWidget.invalidateLayout
▸ invalidateParent(bounds?, force?): MultiHistograms
Invalidate parent area
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | area to invalidate |
Optional force | boolean | force |
this
AnnotatedWidget.invalidateParent
▸ isClippingEnabled(): boolean
Returns if clipping is enabled or not for this node.
boolean
AnnotatedWidget.isClippingEnabled
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
AnnotatedWidget.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
flip
AnnotatedWidget.isHorizontalFlip
▸ isLayoutInvalidated(): boolean
Return true if layout is invalid
boolean
AnnotatedWidget.isLayoutInvalidated
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AnnotatedWidget.isNotificationEnabled
▸ isPickingChildrenEnabled(): boolean
Returns if picking children is enabled or not for this node.
boolean
pickingChildren
AnnotatedWidget.isPickingChildrenEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ isVerticalFlip(): boolean
Return true if the representation is flipped vertically
boolean
flip
AnnotatedWidget.isVerticalFlip
▸ listToolsNames(): string[]
List all the tools contained in this composite. Prepend their parent tools parent using a '.'.
string[]
AnnotatedWidget.listToolsNames
▸ loadTemplate(template, registry?): void
Load template loads the saved visual properties of the current template. It is only a visual representation of the current widget. It does not contain any data
| Name | Type | Description |
|---|---|---|
template | string | template to be applied to current widget |
Optional registry | Registry | registry |
void
▸ moveTo(area, vAlign?, hAlign?): MultiHistograms
MoveTo position of node to specified area
| Name | Type | Description |
|---|---|---|
area | Rect | specified area |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". |
this
▸ notify<E>(type, source, args?): MultiHistograms
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | MultiHistograms | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ Protected notifyRoot(event, source, args?): Node
Notify an even to root node
| Name | Type | Description |
|---|---|---|
event | string | type of event |
source | Node | source who called the event |
Optional args | any | event arguments |
this
▸ off<E>(type?, callback?): MultiHistograms
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: MultiHistograms, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): MultiHistograms
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: MultiHistograms, args: EventMap[E]) => void | to be called |
this
▸ Protected onBoundsChanged(bounds): MultiHistograms
Occurs when bounds has been changed
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
this
AnnotatedWidget.onBoundsChanged
▸ Protected onChildAdded(child): void
This method is called it child or children are added
void
▸ Protected onChildRemoved(child): void
This method is called it child or children are removed
| Name | Type | Description |
|---|---|---|
child | Node | removed child |
void
AnnotatedWidget.onChildRemoved
▸ Protected onParentChanged(node): MultiHistograms
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
AnnotatedWidget.onParentChanged
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AnnotatedWidget.onVisibilityChanged
▸ pan(dx, dy): MultiHistograms
attempts to translate the model using the specific x, y translation
Fires
Events.ModelVisibleLimitsChanged
| Name | Type | Description |
|---|---|---|
dx | number | relative horizontal change |
dy | number | relative vertical change |
this
▸ panModelTo(target, animationOptions?): MultiHistograms
Pans the content to the point.
| Name | Type | Description |
|---|---|---|
target | Point | Point where to pan in model space |
Optional animationOptions | PanAnimationOptions | Animation options |
▸ Protected postRendering(context, callback?): void
To be called after rendering, used for PDF output
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering |
void
▸ Protected preRendering(context, callback?): void
Occurs before child rendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering of geometry |
void
▸ rebuild(force?, changes?): MultiHistograms
Rebuild node. This method resets state, cache, and invalidate node.
| Name | Type | Description |
|---|---|---|
Optional force | boolean | optional boolean parameter that can force invalidation |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ refreshLayout(): MultiHistograms
Refresh layout of inner components of the widget
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AnnotatedWidget.registerAnimationStyle
▸ removeAllGroup(location): MultiHistograms
unbind all group in certain location or all locations
| Name | Type | Description |
|---|---|---|
location | AnnotationLocation | location of annotation that containing axis for limits group |
this
▸ removeAxis(axis): void
remove axis
| Name | Type | Description |
|---|---|---|
axis | Axis | axis to be removed |
void
▸ removeAxisFrom(ref, location): MultiHistograms
refer to axis based on histogram or group and remove the axis from widget
| Name | Type | Description |
|---|---|---|
ref | string | Histogram | Group | id or reference to identify histogram or group related to the axis |
location | AnnotationLocation | location of axis |
▸ removeBaseLayer(baseLayer): MultiHistograms
Remove child baseLayer
this
AnnotatedWidget.removeBaseLayer
▸ removeChild(node, disposeChildren?): MultiHistograms
Remove child node
| Name | Type | Description |
|---|---|---|
node | Node | Node[] | node or array of nodes to be removed |
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
this
▸ removeCssClass(cssclass): MultiHistograms
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
AnnotatedWidget.removeCssClass
▸ removeGroup(groupRef): MultiHistograms
remove group
| Name | Type | Description |
|---|---|---|
groupRef | string | Group | id string or object that contain groupid property |
this
▸ removeHistograms(shapes): MultiHistograms
remove histograms from widget
this
▸ removeHistogramsFromAllGroup(shapes): MultiHistograms
remove histograms from all existing limits group
| Name | Type | Description |
|---|---|---|
shapes | string | string[] | Histogram | Histogram[] | array of histograms or their id |
this
▸ removeHistogramsFromGroup(shapes, groupRef): MultiHistograms
remove histograms from an existing group
| Name | Type | Description |
|---|---|---|
shapes | string | string[] | Histogram | Histogram[] | array of histograms or their id |
groupRef | string | Group | id string or object that contain groupid property |
▸ removeInvalidateHandler(handler): MultiHistograms
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AnnotatedWidget.removeInvalidateHandler
▸ removeLegend(legendPanel): MultiHistograms
remove legend
| Name | Type |
|---|---|
legendPanel | LegendPanel |
▸ removeOverlay(overlay): MultiHistograms
Remove child overlay
this
▸ removeTitle(location): void
remove title in the location
| Name | Type | Description |
|---|---|---|
location | AnnotationLocation | of the title |
void
▸ render(context): void
Render group
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render group |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. This implementation doesn't support cache for now.
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ Protected renderBackground(context, bounds): MultiHistograms
Render background
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render background |
bounds | Rect | group bounds |
this
AnnotatedWidget.renderBackground
▸ Protected renderBaseLayers(context): MultiHistograms
Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render baseLayers |
this
AnnotatedWidget.renderBaseLayers
▸ Protected renderBaseLayersAsync(context, callback): void
Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
AnnotatedWidget.renderBaseLayersAsync
▸ Protected renderChildren(context): void
Render children
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
AnnotatedWidget.renderChildren
▸ Protected renderChildrenAsync(context, callback): void
Render children async
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
callback | () => void | callback function to be called then all children are rendered |
void
AnnotatedWidget.renderChildrenAsync
▸ Protected renderContent(context): void
render to specified context. This method calls preRendering, renderChildren, postRendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected renderContentAsync(context, callback): void
Render children in asynchronous mode
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function to be called then all children are rendered |
void
AnnotatedWidget.renderContentAsync
▸ Protected renderOverlays(context): MultiHistograms
Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
this
AnnotatedWidget.renderOverlays
▸ Protected renderOverlaysAsync(context, callback): void
Render overlays on top of cache in asynchronous mode. This method calls renderOverlays
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
AnnotatedWidget.renderOverlaysAsync
▸ restoreToolState(): MultiHistograms
Restore tools state
this
AnnotatedWidget.restoreToolState
▸ resumeUpdate(rebuild?, changes?): MultiHistograms
Resume auto update
| Name | Type | Description |
|---|---|---|
Optional rebuild | boolean | force rebuild |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ rotate(theta, x, y): MultiHistograms
Rotate bounds around a given coordinate
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
x | number | x coordinate to rotate around |
y | number | y coordinate to rotate around |
this
▸ saveTemplate(registry?): string
Save template saves visual properties of the current template. It is only a visual representation of the current widget. It does not contain any data
| Name | Type | Description |
|---|---|---|
Optional registry | Registry | registry |
string
▸ saveToolsState(): MultiHistograms
Saves tools state
this
AnnotatedWidget.saveToolsState
▸ scale(xx, yy): MultiHistograms
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ scaleModel(xx, yy, posX?, posY?): MultiHistograms
Scale node's contents.
Fires
Events.ModelVisibleLimitsChanged
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
Optional posX | number | x position to scale from (in pxl) |
Optional posY | number | y position to scale from (in pxl) |
▸ setAnimationStyle(animationStyle): MultiHistograms
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
AnnotatedWidget.setAnimationStyle
▸ setAnnotationSize(annotationSize?): MultiHistograms
apply size (width or height) to annotation (convenience method)
Example
{
* west : 50,
* east : '10%',
* south: 'auto'
* }| Name | Type | Description |
|---|---|---|
Optional annotationSize | AnnotationSize | JSON to hold (width or height) of the annotation |
this
AnnotatedWidget.setAnnotationSize
▸ setAnnotationsOptions(options): MultiHistograms
Sets annotations' options. currently setAnnotationOptions can only modify existing annotation, while the constructor for the widget can create new ones.
| Name | Type | Description |
|---|---|---|
options | AnnotationOptions | JSON to hold annotations' options |
this
AnnotatedWidget.setAnnotationsOptions
▸ setAnnotationsScrollBar(options, location): MultiHistograms
set up options for annotation scroll bar
| Name | Type | Description |
|---|---|---|
options | ScrollBarOptions | options |
location | AnnotationLocation | location of annotation that containing axis for the group |
this
▸ setAutoModelLimitsMode(mode): MultiHistograms
Set Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds. This is convenient method. It creates AutoModelLimitsStrategy
| Name | Type | Description |
|---|---|---|
mode | boolean | Model Limits Logics to be used |
this
AnnotatedWidget.setAutoModelLimitsMode
▸ setAutoModelLimitsStrategy(strategy): MultiHistograms
Set Model Limits Logics Strategy
| Name | Type | Description |
|---|---|---|
strategy | ModelLimitsStrategy | Model Limits logic strategy to use |
this
AnnotatedWidget.setAutoModelLimitsStrategy
▸ setAxisOptions(ref, location, options): MultiHistograms
set options of axis
| Name | Type | Description |
|---|---|---|
ref | string | Histogram | Group | shape histogram reference or group reference for identifying the axis |
location | AnnotationLocation | location of the axis |
options | Object | axis options |
Optional options.flip | boolean | check if flip the axis other params could be seen in the definition of axis setOptions methods |
Optional options.length | number | width of vertical axis or height of horizontal axis |
Optional options.tickgenerator | TickGenerator | Options | tickgenOptions options to configure tickgenerator of axis, see setProperties method of related tickgenerator for details |
▸ setAxisSelection(options): MultiHistograms
set up options for axis selection
| Name | Type | Description |
|---|---|---|
options | AxisSelectionOptions | options |
this
▸ setAxisWidthOrHeight(axisRef, length): MultiHistograms
set desired length for the axis
| Name | Type | Description |
|---|---|---|
axisRef | string | Axis | id or reference to identify axis |
length | number | desired width or height for the axis |
this
▸ setBounds(bounds): MultiHistograms
Sets bounds of the node in the parent coordinates
this
▸ setCache(cache, rebuild?): MultiHistograms
Sets cache to be used to cache
| Name | Type | Description |
|---|---|---|
cache | Cache | cache to be used |
Optional rebuild | boolean | rebuild cache |
this
▸ setCenterModelLimits(modellimits): MultiHistograms
Set the model limits of center model
Fires
Events.ModelVisibleLimitsChanged
Example
//artificially expand the widget model limits
import {Rect} from '@int/geotoolkit/util/Rect';
const newLimits = new Rect(0,0,10,10);
widget.setCenterModelLimits(newLimits);| Name | Type | Description |
|---|---|---|
modellimits | Rect | model limits |
AnnotatedWidget.setCenterModelLimits
▸ setChild(index, node): MultiHistograms
Replace child node by index
| Name | Type | Description |
|---|---|---|
index | number | index of the node |
node | Node | node |
this
▸ setClipStyle(style): MultiHistograms
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setContentOrientation(orientation): MultiHistograms
Set content orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | content orientation |
this
AnnotatedWidget.setContentOrientation
▸ setCss(style, merge?): MultiHistograms
Sets CSS style. This style will be applied for all inserted elements
| Name | Type | Description |
|---|---|---|
style | Type | CSS style to be applied to inserted elements |
Optional merge | boolean | merge flag |
this
▸ setCssClass(name): MultiHistograms
Sets css class name of the node to be used to apply CSS style
| Name | Type | Description |
|---|---|---|
name | string | css class name of the node |
this
▸ setCssTransform(transform): MultiHistograms
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
AnnotatedWidget.setCssTransform
▸ setData(data): MultiHistograms
Sets a new data model
| Name | Type | Description |
|---|---|---|
data | DataSource | data model set |
this
▸ setDataBinding(binding, silent?): MultiHistograms
Sets the data binding
| Name | Type | Description |
|---|---|---|
binding | DataBinding | data binding |
Optional silent | boolean | silent mode to forbid |
this
▸ setDesiredHeight(value, silent?): MultiHistograms
Sets desired height of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired height to set, use 'auto' for automatic desired height |
Optional silent | boolean | silent setting |
this
AnnotatedWidget.setDesiredHeight
▸ setDesiredWidth(value, silent?): MultiHistograms
Sets desired width of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired width to set |
Optional silent | boolean | silent setting |
this
AnnotatedWidget.setDesiredWidth
▸ setExportLimits(limits): MultiHistograms
Sets export limits
| Name | Type | Description |
|---|---|---|
limits | Rect | export limits |
AnnotatedWidget.setExportLimits
▸ setExportScale(scale): MultiHistograms
Sets export scale.
| Name | Type | Description |
|---|---|---|
scale | Object | scale |
scale.x | number | scale by x form model to device |
scale.y | number | scale by y form model to device |
AnnotatedWidget.setExportScale
▸ setFillStyle(fillStyle, merge?): MultiHistograms
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ setGaps(options): MultiHistograms
set up gaps for annotations
| Name | Type | Description |
|---|---|---|
options | GapsOptions | options |
this
▸ setHeaderOptions(options?): MultiHistograms
set header options for widget
| Name | Type | Description |
|---|---|---|
Optional options | HeaderOptions | options |
▸ setHighlightableHistograms(shapes, highlightable): MultiHistograms
set if histograms can be highlighted
| Name | Type | Description |
|---|---|---|
shapes | string | string[] | Histogram | Histogram[] | array of histograms |
highlightable | boolean | if histograms are available for selection |
this
▸ setHistogramsVisible(shapes, visible): MultiHistograms
set visibility of histograms and related axis
| Name | Type | Description |
|---|---|---|
shapes | string | string[] | Histogram | Histogram[] | array of histograms |
visible | boolean | set the visibility of histogram and related axis |
this
▸ setHorizontalFlip(enable): MultiHistograms
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip |
this
AnnotatedWidget.setHorizontalFlip
▸ setId(id): MultiHistograms
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setInFrontGroup(groupRef): MultiHistograms
bring the group and the top shape in the group in front of all shapes and then activate it
| Name | Type | Description |
|---|---|---|
groupRef | string | Group | id string or object that contain groupid property |
this
▸ setInFrontHistogram(shape): MultiHistograms
bring the shape in front of all other shapes and activate it
| Name | Type | Description |
|---|---|---|
shape | Histogram | the histogram need to be show on the top |
this
▸ setInfiniteMode(infinityMode): MultiHistograms
Set infinity mode flag to draw composite without collision check
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
this
AnnotatedWidget.setInfiniteMode
▸ setLayout(layout): MultiHistograms
Associate layout with a group.
| Name | Type | Description |
|---|---|---|
layout | Record<string, any> | Layout | layout instance to be set or layout properties to apply |
this
▸ Protected setLayoutInvalidated(invalidated): void
Set invalidation status
| Name | Type | Description |
|---|---|---|
invalidated | boolean | invalidated layout |
void
AnnotatedWidget.setLayoutInvalidated
▸ setLayoutStyle(layoutStyle, silent?, merge?): MultiHistograms
specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style |
Optional silent | boolean | silent setting |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
this
AnnotatedWidget.setLayoutStyle
▸ setLineStyle(lineStyle, merge?): MultiHistograms
Sets border color Returns this
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setLocalTransform(localTransform, force?): MultiHistograms
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
AnnotatedWidget.setLocalTransform
▸ setMarginsStyle(margins, merge?): MultiHistograms
Sets margins style
| Name | Type | Description |
|---|---|---|
margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
this
AnnotatedWidget.setMarginsStyle
▸ setModelLimits(limits): MultiHistograms
Sets inner model limits
| Name | Type | Description |
|---|---|---|
limits | Type | inner limits |
this
AnnotatedWidget.setModelLimits
▸ setModelTransformation(transformation): MultiHistograms
Attempts to set local transformation for the model. NOTE: the local transformation set may not be equal to transformation passed - it depends on current ScaleScrollStrategy set on the node.
| Name | Type | Description |
|---|---|---|
transformation | Transformation | transformation to set |
AnnotatedWidget.setModelTransformation
▸ setName(name): MultiHistograms
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): MultiHistograms
set notification state
| Name | Type | Description |
|---|---|---|
notify | boolean | flag set to invalidate parent or not |
Optional force | boolean | true if parent should be invalidated immediately |
this
AnnotatedWidget.setNotification
▸ setOpacity(opacity, blendMode?): MultiHistograms
Sets node opacity
| Name | Type | Description |
|---|---|---|
opacity | number | node opacity from 0 to 1 |
Optional blendMode | BlendMode | opacity blend mode. If it is normal, opacity will be replaced. |
this
▸ setOptions(options): MultiHistograms
set options for widget
| Name | Type | Description |
|---|---|---|
options | OptionsBase | options |
this
▸ setPaddingStyle(paddingStyle, merge?): MultiHistograms
Sets padding style
| Name | Type | Description |
|---|---|---|
paddingStyle | Type<string | number> | padding style |
Optional merge | boolean | true if you want to merge paddingStyle with existing attribute, false by default |
this
AnnotatedWidget.setPaddingStyle
▸ setProperties(props?): MultiHistograms
set properties for widget
| Name | Type | Description |
|---|---|---|
Optional props | Options | object properties |
this
▸ setProperty(name, value): MultiHistograms
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): MultiHistograms
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
AnnotatedWidget.setRenderingFilter
▸ setResponsiveStyle(style): MultiHistograms
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
AnnotatedWidget.setResponsiveStyle
▸ setScaleScrollStrategy(delegate): MultiHistograms
set the scale scroll strategy to apply to the widget
| Name | Type | Description |
|---|---|---|
delegate | Delegate | scaleScrollStrategy to set |
this
AnnotatedWidget.setScaleScrollStrategy
▸ setSelectable(selectable): MultiHistograms
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
▸ setSilent(bool): MultiHistograms
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): MultiHistograms
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
this
▸ setTitleOptions(location, options): MultiHistograms
set options for title
| Name | Type | Description |
|---|---|---|
location | AnnotationLocation | of the title |
options | Omit<TitleOptions, "location"> | title options |
AnnotatedWidget.setTitleOptions
▸ Protected setTool(tool): MultiHistograms
Set root tool associated to this widget
| Name | Type | Description |
|---|---|---|
tool | CompositeTool | tool to be set |
▸ setToolsOptions(options): MultiHistograms
set up tools options
| Name | Type | Description |
|---|---|---|
options | ToolsOptions | options |
this
AnnotatedWidget.setToolsOptions
▸ setVerticalFlip(flip): MultiHistograms
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
this
AnnotatedWidget.setVerticalFlip
▸ setVisible(value): MultiHistograms
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setVisibleCenterModelLimits(newVisibleModelLimits): MultiHistograms
Attempts to set model's visible limits to specified limits. NOTE: the limits set may not be equal to the limit passed - it depends on current ScaleScrollStrategy set on the node.
Fires
Events.ModelVisibleLimitsChanged
| Name | Type | Description |
|---|---|---|
newVisibleModelLimits | Rect | limits to set |
AnnotatedWidget.setVisibleCenterModelLimits
▸ setVisibleModelLimits(newVisibleModelLimits): MultiHistograms
Attempts to set model's visible limits to specified limits. NOTE: the limits set may not be equal to the limit passed - it depends on current ScaleScrollStrategy set on the node.
| Name | Type | Description |
|---|---|---|
newVisibleModelLimits | Rect | limits to set |
AnnotatedWidget.setVisibleModelLimits
▸ setZIndex(value): MultiHistograms
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): MultiHistograms
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ suspendUpdate(): MultiHistograms
Suspend auto update
this
▸ Protected synchronizeViewLimits(): MultiHistograms
AnnotatedWidget.synchronizeViewLimits
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): MultiHistograms
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ translateModel(tx, ty): MultiHistograms
Translates widget's contents.
Fires
Events.ModelVisibleLimitsChanged
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
AnnotatedWidget.translateModel
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | AnimatedNode | root node for node |
void
AnnotatedWidget.unregisterAnimationStyle
▸ updateLayout(targets?): MultiHistograms
Updates layout(s)
Fires
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | optional parameter about which element to layout |
this
▸ updateSceneTransformation(): MultiHistograms
Update scene transformation
this
AnnotatedWidget.updateSceneTransformation
▸ updateState(regions?, changes?): MultiHistograms
Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles in the parent coordinates |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ updateSuspended(): boolean
Return state of suspend state
boolean
state of update
AnnotatedWidget.updateSuspended
▸ Protected updateTimeStamp(): MultiHistograms
Update time stamp to indicate that Node or Children has been changed.
this
AnnotatedWidget.updateTimeStamp
▸ zoomIn(): MultiHistograms
zoom in, with default factor = 5/4
this
▸ zoomOut(): MultiHistograms
zoom out, with default factor = 5/4
this
▸ zoomToRect(limits?): void
Sets visible model limits
Fires
Events.ModelVisibleLimitsChanged
| Name | Type | Description |
|---|---|---|
Optional limits | Rect | the visible model limits |
void
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
AnnotatedWidget.enableSceneGraphNotification
▸ Static findParent<T>(node, classType, filter?): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
InstanceType<T>
▸ Static findParent(node, classType, filter?): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
▸ Static getClassName(): string
string
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean