Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxDataChartMouseButtonEventArgs

Provides data for IgxDataChartComponent mouse button related events.

DataChartMouseButtonEventHandler class represents the method that will handle IgxDataChartComponent mouse button related events.

 <igx-data-chart  #chart
      [dataSource]="data"
      (seriesMouseLeftButtonDown)="chart_seriesMouseLeftButtonDown()">
      <igx-category-x-axis
        label="label"
        #xAxis
        >
      </igx-category-x-axis>
      <igx-numeric-y-axis
        minimumValue="0"
        #yAxis>
      </igx-numeric-y-axis>

      <igx-column-series
        [xAxis]="xAxis"
        [yAxis]="yAxis"
        valueMemberPath="value">
      </igx-column-series>
    </igx-data-chart>

this.chart.seriesMouseLeftButtonDown.subscribe(this.chart_seriesMouseLeftButtonDown);
chart_seriesMouseLeftButtonDown(sender :any,args: DataChartMouseButtonEventArgs )
  {
  }

Hierarchy

Hierarchy

  • IgxDataChartMouseButtonEventArgs

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_cancelSelection

ngAcceptInputType_cancelSelection: string | boolean

Static ngAcceptInputType_chartPosition

ngAcceptInputType_chartPosition: string | IgPoint

Static ngAcceptInputType_handled

ngAcceptInputType_handled: string | boolean

Static ngAcceptInputType_plotAreaPosition

ngAcceptInputType_plotAreaPosition: string | IgPoint

Static ngAcceptInputType_worldPosition

ngAcceptInputType_worldPosition: string | IgPoint

Accessors

cancelSelection

  • get cancelSelection(): boolean

  • Gets or sets whether to cancel series selection.

    Returns boolean

  • set cancelSelection(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

chart

  • get chart(): IgxSeriesViewerComponent

  • Gets the Chart associated with the current event.

    Use the Chart property to get the chart associated with the current event.

    var dataChart=  args.chart;

    Returns IgxSeriesViewerComponent

  • set chart(v: IgxSeriesViewerComponent): void

  • Parameters

    Returns void

chartPosition

  • get chartPosition(): IgPoint

  • Gets the mouse position relative to the chart.

    Returns IgPoint

handled

  • get handled(): boolean

  • Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. ChartMouseButton events are not routed events; setting this property effects the underlying MouseButtonEvent.

    Use the handled property to indicates the present state of the event handling for a routed event.

    Returns boolean

  • set handled(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

item

  • get item(): any

  • Gets the ItemsSource item associated with the current event.

    Use the Item property to get the ItemsSource item associated with the current event.

    var item1= args.item;

    Returns any

  • set item(v: any): void

  • Parameters

    • v: any

    Returns void

originalSource

  • get originalSource(): any

  • Gets a reference to the object that raised the event.

    Use the OriginalSource property for the raised object event.

    args.originalSource;

    Returns any

plotAreaPosition

  • get plotAreaPosition(): IgPoint

  • Gets the mouse position relative to the plot area.

    Returns IgPoint

  • set plotAreaPosition(v: IgPoint): void

  • Parameters

    Returns void

series

  • get series(): IgxSeriesComponent

  • Gets the series associated with the current event.

    Use the Series property for the associated current event.

     var DataSeries= args.series;

    Returns IgxSeriesComponent

  • set series(v: IgxSeriesComponent): void

  • Parameters

    Returns void

worldPosition

  • get worldPosition(): IgPoint

  • Returns IgPoint

  • set worldPosition(v: IgPoint): void

  • Parameters

    Returns void

Methods

getPosition

  • Returns the x- and y- coordinates of the mouse pointer position, optionally evaluated against the origin of a supplied UIElement.

    Parameters

    • relativeTo: any
      • Any UIElement derived object that is contained by the the engine plug-in and connected to the object tree. To specify the object relative to the overall the engine coordinate system, use a relativeTo value of null.

      To get mouse X and Y position.

         var args.getPosition;

    Returns IgPoint

toString

  • Provides a human readable description of the mouse button event.

    Use the ToString property to provides a human readable discription.

      var item= args.item.label.toString();

    Returns string