Owning Axis.
Attach object to an legendBox entry
Object which has to be attached
Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.
Object itself for fluent interface
Tell the owning chart to remove this component.
Object itself.
Get boolean flag for whether object should highlight on mouse hover
Boolean for if object should highlight on mouse hover or not.
the state of highlighted flag
Get boolean flag for whether object is currently under mouse or not
Boolean for is object under mouse currently
Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.
Mouse interactions state
Get the name of the Component.
The name of the Component.
Get stroke style of ConstantLine.
Normal StrokeStyle
Get highlight stroke style of ConstantLine.
StrokeStyle.
Get value of ConstantLine. This is in values of its owning Axis.
Value on Axis.
TODO: True for enabled and false for disabled
Unsubscribe from Highlight object event. This is called whenever an object is highlighted
Token that was received when subscribing to the event.
True if the unsubscription was successful.
Remove event listener from Mouse Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Double Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Down Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Stop Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Enter Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Leave Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Up Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Wheel Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch End Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Unsubscribe from value change event.
This event is called whenever the position of the ConstantLine is changed via either ConstantLine.setValueStart/End or user interactions.
Token that was received when the subscription was created.
True if unsubscription was successful.
Subscribe to highlight object event. This is called whenever an object is highlighted.
Function that is called when event is triggered.
Token that can be used to unsubscribe from the event.
Add event listener to Mouse Click Event
Event listener for Mouse Click Event
Token of the event listener
Add event listener to Mouse Double Click Event
Event listener for Mouse Double Click Event
Token of the event listener
Add event listener to Mouse Down Event
Event listener for Mouse Down Event
Token of the event listener
Subscribe to Mouse Drag event
Subscribe to Mouse Drag Start event
Subscribe to Mouse Drag Stop event
Add event listener to Enter Event
Event listener for Mouse Enter Event
Token of the event listener
Add event listener to Mouse Leave Event
Event listener for Mouse Leave Event
Token of the event listener
Add event listener to Mouse Move Event
Event listener for Mouse Move Event
Token of the event listener
Add event listener to Mouse Up Event
Event listener for Mouse Up Event
Token of the event listener
Subscribe to Mouse Wheel event
Event handler function
Token of subscription
Subscribe to Touch End event
Event handler function
Token of subscription
Subscribe to Touch Move event
Event handler function
Token of subscription
Subscribe to Touch Start event
Event handler function
Token of subscription
Subscribe to value change event.
This event is called whenever the position of the ConstantLine is changed via either ConstantLine.setValueStart/End or user interactions.
Function that is called when event is triggered.
Token that can be used to unsubscribe from the event.
Tell the owning chart to restore this component.
Object itself.
Set highlight on mouse hover enabled or disabled.
Mouse interactions have to be enabled on the component for this to function as expected. See setMouseInteractions for more information.
True if highlighting on mouse hover, false if no highlight on mouse hover
Object itself for fluent interface.
Enable or disable forced highlighting of component
True for enabled and false for disabled
component itself for fluent interface
Set component mouse interactions enabled or disabled.
Disabling mouse interactions means that the objects below this component can be interacted through it.
Possible side-effects from disabling mouse interactions:
Specifies state of mouse interactions
Object itself for fluent interface
Sets the name of the Component updating attached LegendBox entries
Name of the Component
Object itself
Set stroke style of ConstantLine.
Example usage:
// Specified SolidLine
ConstantLine.setStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
ConstantLine.setStrokeStyle((solidLine) => solidLine.setThickness(5))
Either a SolidLine object or a function, which will be used to create a new SolidLine based on current value.
Chart itself
Set stroke style of ConstantLine when it is highlighted. Highlighting is activated by placing mouse on top / touching ConstantLine (if mouse-interactions are not disabled), or by using setHighlighted() method.
Example usage:
// Specified SolidLine
ConstantLine.setStrokeStyleHighlight(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
// Changed thickness
ConstantLine.setStrokeStyleHighlight((solidLine) => solidLine.setThickness(5))
// Hidden (emptyLine is not supported)
ConstantLine.setStrokeStyleHighlight(transparentLine)
// Automatic
ConstantLine.setStrokeStyleHighlight(undefined)
Either a SolidLine object or a function, which will be used to modify current value or undefined for automatic value based on normal style.
Chart itself
Set value of ConstantLine. This is in values of its owning Axis.
Value on Axis.
Object itself for fluent interface.
Axis Highlighter that highlights a single position on the Axis.