Data Filters API

# dataFilterWidth


# filterDataBy

filterDataBy filter
Filter data by their value in the 'data' object used in oncoprints. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Heatmap

# filterEdgeBy

filterEdgeBy filter
Filter edges by their properties used in network graphs. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Network

# filterFeatureBy

filterFeatureBy filter
Filter features by their properties used in genome browser. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Genome

# filterMode

filterMode option
Mode for the filter. Can be 'remove' to remove the data from the plot, 'hide' to hide the data similarily to legend filters (may be useful to adjustor transparencyHidden) or 'color' to color the data point with a set color (may be useful to adjust missingDataColor).
Default: remove
Options: remove, hide, color

# filterNodeBy

filterNodeBy filter
Filter nodes by their properties used in network graphs. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}
Used in: Network

# filterSkipNullKeys

filterSkipNullKeys boolean
Flag to indicate to bypass filtering when a key is non existent in the data objects.
Default: false

# filterSkipNullValues

filterSkipNullValues boolean
Flag to indicate to bypass filtering when a value is null.
Default: false

# filterSmpBy

filterSmpBy filter
Filter samples by their annotation included in the 'data.x' object used in one dimensional plots. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}

# filterType

filterType option
Type for the filter. Can be 'and' or 'or'.
Default: and
Options: and, or

# filterVarBy

filterVarBy filter
Filter variables by their annotation included in the 'data.z' object used in one dimensional plots. Used in the CanvasXpress UIs.
Default: {'cases':[],'comp':[],'op':[],'type':[],'value':[]}

# filtersExposed

filtersExposed array
Exposed filters after rendering the plot. Each element in the array is an object as follows: {name: [var or smp annotation|vars|smps], position: [topRight|topLeft|bottomRight|bottomLeft], css: {property:value}}
Default: []