can.interact {iNZightPlots} | R Documentation

## Identify if a plot can be interactive

### Description

Several iNZightPlots graphs have been enabled with custom interaction, while others make use of the automatic output of 'plotly'. This function returns 'TRUE' if the provided plot has interaction (as determined by iNZight), and 'FALSE' otherwise.

### Usage

    can.interact(x)

    ## Default S3 method:
    can.interact(x)

    ## S3 method for class 'inzplotoutput'
    can.interact(x)

    ## S3 method for class 'ggplot'
    can.interact(x)

### Arguments

`x` | a plot object returned from a plotting function

### Details

Not that, while most 'ggplot2' graphs can be passed to 'plotly', and even though we are using plot.ly directly for some of our ggplot2 graphs, we still only return 'TRUE' if the graph was created by one of the packages in the iNZight collection.

### Value

Logical to identify if there is an interactive version

### Methods (by class)

- `default`: Default interaction helper (always returns 'FALSE')

- `inzplotoutput`: Graphs from 'iNZightPlot()', many of which have interaction enabled, but some do not (for example, hex plots)

- `ggplot`: Those 'iNZight*' plotting functions which return a 'ggplot2' object and have been tested to work with plotly will be tagged as such; this is just a helper to check for the necessary attribute.

### Author(s)

Tom Elliott, Yu Han Soh

### Examples

    can.interact(iNZightPlot(Sepal.Length, data = iris))

[Package iNZightPlots version 2.14.1 Index]