Class ModifierGroup

Allows a collection of modifiers to be added to the SciChartSurface#getChartModifiers(). Child modifiers are stored in the ModifierGroup#childModifiers collection.

Inheritance
java.lang.Object
ReceiveMotionEventsBase
ChartModifierCore
ChartModifierBase
ModifierGroup
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class ModifierGroup extends ChartModifierBase implements IReceiveMotionEventGroup

Constructors

ModifierGroup()

Creates a new ModifierGroup instance.

Declaration
public ModifierGroup()

ModifierGroup(IChartModifier[] childModifiers)

Creates a new ModifierGroup instance.

Declaration
public ModifierGroup(IChartModifier[] childModifiers)
Parameters
Type Name Description
IChartModifier[] childModifiers

The child modifiers.

Methods

applyThemeProvider(IThemeProvider themeProvider)

Applies specified theme to current instance

Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type Name Description
IThemeProvider themeProvider
Overrides

attachTo(IServiceContainer services)

Declaration
public void attachTo(IServiceContainer services)
Parameters
Type Name Description
IServiceContainer services
Overrides

detach()

Declaration
public void detach()
Overrides

getChildModifierByTag(String eventsGroupTag)

Looks for a IChartModifier with the specified eventsGroupTag in the collection of child modifiers.

Declaration
public final IChartModifier getChildModifierByTag(String eventsGroupTag)
Parameters
Type Name Description
String eventsGroupTag

Tag of the event group.
Returns
Type Description
IChartModifier

The IChartModifier instance associated with eventsGroupTag.

getChildModifiers()

Gets the list of IChartModifier in this group.

Declaration
public final ChartModifierCollection getChildModifiers()
Returns
Type Description
ChartModifierCollection

The list of modifiers in this group.

getEventsSource()

Gets the (@Link IChartModifierSurface) associated with this (@Link ModifierGroup).

Declaration
public IHitTestable getEventsSource()
Returns
Type Description
IHitTestable

getMotionEventGroup()

Declaration
public final String getMotionEventGroup()
Returns
Type Description
String

isTouchArgsValidForModifier(ModifierTouchEventArgs args, IChartModifier modifier)

Checks if ModifierTouchEventArgs are valid for specified modifier

Declaration
protected boolean isTouchArgsValidForModifier(ModifierTouchEventArgs args, IChartModifier modifier)
Parameters
Type Name Description
ModifierTouchEventArgs args

The args to process by modifier
IChartModifier modifier

The target modifier
Returns
Type Description
boolean

True if args are valid and should be passed to target modifier, otherwise false

onAnnotationsCollectionChanged(CollectionChangedEventArgs<IAnnotation> args)

Called when parent SciChartSurface#getAnnotations() collection changes

Declaration
public void onAnnotationsCollectionChanged(CollectionChangedEventArgs<IAnnotation> args)
Parameters
Type Name Description
CollectionChangedEventArgs<IAnnotation> args
Overrides

onAnnotationsDrasticallyChanged()

Called when parent SciChartSurface#getAnnotations() collection drastically changed

Declaration
public void onAnnotationsDrasticallyChanged()
Overrides

onGenericMotion(ModifierTouchEventArgs args)

Declaration
public void onGenericMotion(ModifierTouchEventArgs args)
Parameters
Type Name Description
ModifierTouchEventArgs args
Overrides

onIsEnabledChanged(boolean isEnabled)

Called when isEnabled value has changed

Declaration
protected void onIsEnabledChanged(boolean isEnabled)
Parameters
Type Name Description
boolean isEnabled
Overrides

onParentSurfaceResized(ResizedMessage message)

Called when chart resized.

Declaration
public void onParentSurfaceResized(ResizedMessage message)
Parameters
Type Name Description
ResizedMessage message
Overrides

onRenderSurfaceRendered(RenderedMessage message)

Called when parent SciChartSurface#getRenderSurface() rendered

Declaration
public void onRenderSurfaceRendered(RenderedMessage message)
Parameters
Type Name Description
RenderedMessage message
Overrides

onRenderableSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)

Called when RenderableSeries changes

Declaration
public void onRenderableSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)
Parameters
Type Name Description
CollectionChangedEventArgs<? extends com.scichart.charting.visuals.renderableSeries.IRenderableSeriesCore> args
Overrides

onRenderableSeriesDrasticallyChanged()

Called when RenderableSeries collection drastically changed

Declaration
public void onRenderableSeriesDrasticallyChanged()
Overrides

onSelectedSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)

Called when SelectedSeries collection changes

Declaration
public void onSelectedSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)
Parameters
Type Name Description
CollectionChangedEventArgs<? extends com.scichart.charting.visuals.renderableSeries.IRenderableSeriesCore> args
Overrides

onTouch(ModifierTouchEventArgs args)

Declaration
public void onTouch(ModifierTouchEventArgs args)
Parameters
Type Name Description
ModifierTouchEventArgs args
Overrides

onXAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)

Called when parent SciChartSurface#getXAxes() collection changes

Declaration
public void onXAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)
Parameters
Type Name Description
CollectionChangedEventArgs<IAxis> args
Overrides

onXAxesDrasticallyChanged()

Called when parent SciChartSurface#getXAxes() collection drastically changed

Declaration
public void onXAxesDrasticallyChanged()
Overrides

onYAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)

Called when parent SciChartSurface#getYAxes() collection changes

Declaration
public void onYAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)
Parameters
Type Name Description
CollectionChangedEventArgs<IAxis> args
Overrides

onYAxesDrasticallyChanged()

Called when parent SciChartSurface#getYAxes() collection drastically changed

Declaration
public void onYAxesDrasticallyChanged()
Overrides

setChildModifiers(ChartModifierCollection childModifiers)

Sets the list of IChartModifier in this group.

Declaration
public final void setChildModifiers(ChartModifierCollection childModifiers)
Parameters
Type Name Description
ChartModifierCollection childModifiers

The new list of modifiers in this group.

setMotionEventGroup(String eventGroup)

Sets the ID of the motion event group, which is used to share motion events across multiple targets.

Declaration
public final void setMotionEventGroup(String eventGroup)
Parameters
Type Name Description
String eventGroup

The String tag of the motion event group.

Implements