API / geotoolkit / controls / shapes / RegressionLine / RegressionLine
shapes.RegressionLine.RegressionLine
RegressionLine shape wrap a regression model and draw the curve (and also confidence and prediction interval) for the given data set x and y based on the model
↳
RegressionLine
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
autolimits | boolean | Enable auto calculate model limits base on lines geometry |
clipstyle | ClipStyle | Clipping style |
clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
clipstyle-geometry | GraphicsPath | Clipping geometry |
clipstyle-geometry-bounds | Rect | Bounds |
clipstyle-geometry-bounds-height | number | Height |
clipstyle-geometry-bounds-readonly | boolean | Readonly |
clipstyle-geometry-bounds-width | number | Width |
clipstyle-geometry-bounds-x | number | Left |
clipstyle-geometry-bounds-y | number | Top |
clipstyle | GraphicsPath | Clipping style |
confidenceline | ProbabilityLineOptions | Options for confidence line |
confidenceline-fillstyle | string | Fill style of the fill area between upper and lower confidence/prediction lines |
confidenceline-fillstyle | FillStyle | Fill style of the fill area between upper and lower confidence/prediction lines |
confidenceline-fillstyle-color | string | Color in CSS form |
confidenceline-fillstyle-evenoddmode | boolean | Even-odd fill mode |
confidenceline-fillstyle-fillpattern | Pattern | Pattern |
confidenceline-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 |
confidenceline-fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
confidenceline-fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
confidenceline-fillstyle-foreground | string | Foreground color |
confidenceline-fillstyle-pattern | Pattern | Pattern |
confidenceline-label | ProbabilityLabelOptions | Probability line label options |
confidenceline-label-lower | LabelOptions | Probability line lower label options |
confidenceline-label-lower-anchortype | AnchorType | Label anchor type |
confidenceline-label-lower-fillstyle | string | Label fill style |
confidenceline-label-lower-fillstyle | FillStyle | Label fill style |
confidenceline-label-lower-linestyle | string | Label border line style |
confidenceline-label-lower-linestyle | LineStyle | Label border line style |
confidenceline-label-lower-linestyle-color | string | Color in CSS form |
confidenceline-label-lower-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
confidenceline-label-lower-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
confidenceline-label-lower-linestyle-linecap | CapStyle | The line cap style |
confidenceline-label-lower-linestyle-linedashoffset | number | Line dash offset of dashed line |
confidenceline-label-lower-linestyle-linejoin | JoinStyle | The line join style |
confidenceline-label-lower-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
confidenceline-label-lower-linestyle-scalable | boolean | True if width should depend on transformation |
confidenceline-label-lower-linestyle-unit | string | Optional unit for the width |
confidenceline-label-lower-linestyle-width | number | string | The line thickness |
confidenceline-label-lower-location | number | The distance of the label in the range of [0, 1] 0 is the start point of the line, from the left end 1 is the end point of the line, the right end |
confidenceline-label-lower-offset | number | Offset of label in device space with the line |
confidenceline-label-lower-text | string | Label text |
confidenceline-label-lower-textstyle | string | Label text style |
confidenceline-label-lower-textstyle | TextStyle | Label text style |
confidenceline-label-lower-textstyle-alignment | AlignmentStyle | Alignment |
confidenceline-label-lower-textstyle-autosize | boolean | Auto font size on high definition display |
confidenceline-label-lower-textstyle-background | string | Background style |
confidenceline-label-lower-textstyle-background | FillStyle | Background style |
confidenceline-label-lower-textstyle-baseline | BaseLineStyle | Base line |
confidenceline-label-lower-textstyle-color | string | Color in CSS form |
confidenceline-label-lower-textstyle-fill | FillStyle | Text fill style |
confidenceline-label-lower-textstyle-font | string | Font see |
confidenceline-label-lower-textstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
confidenceline-label-lower-textstyle-lineheight | string | number | Line height |
confidenceline-label-lower-textstyle-multiline | boolean | Allow multi-line text |
confidenceline-label-lower-textstyle-outline | string | Outline style |
confidenceline-label-lower-textstyle-outline | LineStyle | Outline style |
confidenceline-label-lower-textstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
confidenceline-label-lower-textstyle-strikethrough | string | Strikethrough style |
confidenceline-label-lower-textstyle-strikethrough | LineStyle | Strikethrough style |
confidenceline-label-lower-textstyle-textoverflow | TextOverflowStyle | Text overflow |
confidenceline-label-lower-textstyle-underline | string | Underline style |
confidenceline-label-lower-textstyle-underline | LineStyle | Underline style |
confidenceline-label-lower-textstyle-underlineoffset | string | number | Underline offset distance |
confidenceline-label-lower-textstyle-whitespace | WhiteSpaceStyle | White space |
confidenceline-label-lower-textstyle-wordbreak | WordBreakStyle | Word break |
confidenceline-label-lower-visible | boolean | Label visibility |
confidenceline-label-upper | LabelOptions | Probability line upper label options |
confidenceline-probability | Probability | The probability for looking up t-table to determine interval the rest see setLineOptions for details |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
databounds | Rect | Regression line data bounds to limit regression line and its confident/prediction lines within a specific bounds in model space |
datax | INumericalDataSeries | Data source for x |
datax-id | number | string | Unique id of the data series |
datax-name | string | Name |
datax-type | string | Type |
datax-uri | string | Unique resource identifier |
datay | INumericalDataSeries | Data source for y |
extended | boolean | The flag if extend x limits of curve to the limits of shape's model limits |
fillstyle | string | Style applied on fill |
fillstyle | FillStyle | Style applied on fill |
horizontallogmode | boolean | Log mode in horizontal direction |
id | string | number | Id of the node, its a unique identifier |
infinity | boolean | Infinity mode flag to draw regression line outside the model limits |
linestyle | string | Style applied on outline |
linestyle | LineStyle | Style applied on outline |
localtransform | Transformation | Local transformation |
localtransform-dx | number | X axis translation |
localtransform-dy | number | Y axis translation |
localtransform-xx | number | X scale |
localtransform-xy | number | Xy skew |
localtransform-yx | number | Yx skew |
localtransform-yy | number | Y scale |
margins | number | string | It has properties for specifying the margins for each side |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
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 |
opacityblendmode | BlendMode | Node opacity mode to blend it |
plotinterval | number | The interval of sampling x when drawing curve |
predictionline | ProbabilityLineOptions | Options for prediction line |
regressionline | LineOptions | Options for regression line |
regressionline-label | LabelOptions | Regression line label options |
regressionline-linestyle | string | Set line style of this type of line |
regressionline-linestyle | LineStyle | Set line style of this type of line |
regressionline-visible | boolean | Set visibility of this type of line |
residualline | ResidualLine | Residual line setting for the line connecting data point with regression line |
residualline-linestyle | string | Residual line line style |
residualline-linestyle | LineStyle | Residual line line style |
residualline-mode | ResidualLineMode | Residual line mode |
residualline-visible | boolean | Whether residual lines should be visible |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
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 |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
verticallogmode | boolean | Log mode in vertical direction |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
weights | INumericalDataSeries | Weights of data point |
z-index | number | Define node z-index |
Methods
▸ addCssClass(cssclass): RegressionLine
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): RegressionLine
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
ScaledShape.addInvalidateHandler
▸ Protected applyOpacity(context): RegressionLine
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
ScaledShape.applyResponsiveStyle
▸ checkCollision(context): boolean
Check collision
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of rendering area
▸ clone(): RegressionLine
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): RegressionLine
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
▸ Protected copyConstructor(src, deepCopy?): RegressionLine
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | RegressionLine | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ disconnectStyle(style, type, callback): RegressionLine
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
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ enableEventPropagation(enable): RegressionLine
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
ScaledShape.enableEventPropagation
▸ execute(delegate): RegressionLine
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: RegressionLine) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: RegressionLine) => T |
T
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
▸ getAutoLimits(): boolean
Get whether model limits to be automatically calculated base on lines geometry
Deprecated
since 4.1. Not used anymore
boolean
True if auto limits enabled, false otherwise
▸ getBounds(): Rect
get model bounds of shape
bounds
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ 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
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
ScaledShape.getInvalidateMethod
▸ getLineControlPoints(lineType?): Object
Get regression line start and end points
| Name | Type | Description |
|---|---|---|
Optional lineType | LineTypeExtended | Type of line |
Object
Object defines start and end points of the line
▸ getLineGeometry(lineType, bounds?): GraphicsPath
Get line geometry
| Name | Type | Description |
|---|---|---|
lineType | LineTypeExtended | Type of line |
Optional bounds | Rect | Bounds to calculate line geometry within |
Line geometry
▸ getLineStyle(): LineStyle
Return line style
lineStyle current line style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getModelLimits(): Rect
get model limits of shape
limits
▸ 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
ScaledShape.getOpacityBlendMode
▸ getOptions(): OptionsBaseOut
get options of shape
▸ getParent(): Node
Return parent node
parent node
▸ getProperties(): OptionsOut
get properties of shape
properties
▸ 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[]
▸ getRegressionModel(): RegressionBase
get current regression model
resolved regression model
▸ getRegressionModelOptions(): OptionsOut & { type: RegressionBase }
get options for regression model
OptionsOut & { type: RegressionBase }
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
ScaledShape.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
ScaledShape.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
ScaledShape.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
▸ getStatistics(): Statistics
get statistics of regression model
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
transform the world transform.
▸ 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
▸ hitTest(area, radius?): string[]
string[]
▸ invalidate(bounds?, force?): RegressionLine
Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | true if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
this
▸ invalidateParent(bounds?, force?): RegressionLine
Invalidate bounds
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
Optional force | boolean | flag indicating if the parent must be forcibly invalidated |
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
ScaledShape.isEventPropagationEnabled
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
ScaledShape.isNotificationEnabled
▸ 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
▸ notify<E>(event, source, args?): RegressionLine
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
event | E | type of event |
source | AbstractNode | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off<E>(type?, callback?): RegressionLine
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: RegressionLine, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): RegressionLine
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: RegressionLine, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(node): RegressionLine
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
ScaledShape.onVisibilityChanged
▸ Protected postRendering(context): void
To be called after rendering. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
ScaledShape.registerAnimationStyle
▸ removeCssClass(cssclass): RegressionLine
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): RegressionLine
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
ScaledShape.removeInvalidateHandler
▸ render(context): void
Renders node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ rotate(theta, x, y): RegressionLine
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
▸ scale(xx, yy): RegressionLine
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): RegressionLine
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setAutoLimits(enabled): RegressionLine
Set whether model limits to be automatically calculated base on lines geometry
Deprecated
since 4.1. Not used anymore
| Name | Type | Description |
|---|---|---|
enabled | boolean | Enabled auto limits |
this
▸ setBounds(bounds): RegressionLine
set model bounds of shape
| Name | Type | Description |
|---|---|---|
bounds | Rect | model bounds |
this
▸ setClipStyle(style): RegressionLine
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCss(style, merge?): RegressionLine
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): RegressionLine
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): RegressionLine
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setData(data, incremental?): RegressionLine
set data source for x and y
| Name | Type | Description |
|---|---|---|
data | DataOptions | data |
Optional incremental | boolean | incremental |
this
▸ setExtended(extended): RegressionLine
set if extend x limits of curve from the limit of data set x to the x model limits(since they could be different)
| Name | Type | Description |
|---|---|---|
extended | boolean | the flag to determine if extend x limits |
this
▸ setFillStyle(fillStyle, merge?): RegressionLine
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
▸ setId(id): RegressionLine
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setInfiniteMode(infinityMode): RegressionLine
Set infinity mode flag to draw regression line outside the model limits
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
this
▸ setLineStyle(lineStyle, merge?): RegressionLine
Sets line style
| 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?): RegressionLine
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
▸ setMarginsStyle(margins, merge?): RegressionLine
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
▸ setModelLimits(limits): RegressionLine
set model limits of shape
| Name | Type | Description |
|---|---|---|
limits | Rect | model limits |
this
▸ setName(name): RegressionLine
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): RegressionLine
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
▸ setOpacity(opacity, blendMode?): RegressionLine
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): RegressionLine
set options for shape
| Name | Type | Description |
|---|---|---|
options | OptionsBase | options |
▸ setPlotInterval(interval): RegressionLine
set the interval when sampling the x for drawing curve
| Name | Type | Description |
|---|---|---|
interval | number | the sampling interval in screen pixel |
this
▸ setProperties(properties?): RegressionLine
set properties for shape
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
▸ setProperty(name, value): RegressionLine
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): RegressionLine
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
ScaledShape.setRenderingFilter
▸ setResponsiveStyle(style): RegressionLine
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
ScaledShape.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): RegressionLine
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
ScaledShape.setScaleScrollStrategy
▸ setSelectable(selectable): RegressionLine
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): RegressionLine
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): RegressionLine
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
▸ setVisible(value): RegressionLine
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setZIndex(value): RegressionLine
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): RegressionLine
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): RegressionLine
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
ScaledShape.unregisterAnimationStyle
▸ Protected updateGeometry(): RegressionLine
▸ Protected updateLabelGeometry(): RegressionLine
▸ Protected updateResidualLineGeometry(): RegressionLine
▸ updateSceneTransformation(): RegressionLine
Update scene transformation
this
ScaledShape.updateSceneTransformation
▸ Protected updateSplineGeometry(): RegressionLine
▸ updateState(regions?, changes?): RegressionLine
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
▸ Protected updateTimeStamp(): RegressionLine
Update time stamp to indicate that Node or Children has been changed.
this
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
ScaledShape.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 intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean
Check collision of the shape bounds with parent invalid area
| Name | Type | Description |
|---|---|---|
bounds | Rect | shape bounds |
localTransformation | Transformation | local transformation of the bounds |
parentInvalidArea | Rect | invalid parent area |
Optional expand | Dimension | optional expand the bounds in model coordinate |
boolean
true if bounds intersect the invalid area
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean