API Documentation

class upsetjs_jupyter_widget.UpSetJSWidget(**kwargs)[source]

UpSet.js Widget

alternating_background_color

A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’

append_categorical_attribute(name, values, categories=None)[source]

adds another categorical UpSetAttribute to be visualized

Parameters
Return type

UpSetJSWidget

append_numeric_attribute(name, values, min_value=None, max_value=None)[source]

adds another numerical UpSetAttribute to be visualized

Parameters
Return type

UpSetJSWidget

attrs

An instance of a Python list.

band_scale

An enum whose value must be in a given sequence.

bar_label_offset

A float trait.

bar_padding

padding argument for scaleBand (0..1)

clear_attributes()[source]

deletes the list of attributes

Return type

UpSetJSWidget

combination_name

A trait for unicode strings.

combination_name_axis_offset

A float trait.

copy()[source]

returns a copy of itself

Return type

UpSetJSWidget

dot_padding

A float trait.

from_dataframe(data_frame, attributes=None, order_by='cardinality', limit=None, colors=None)[source]

generates the list of sets from a dataframe

Parameters
Return type

UpSetJSWidget

from_dict(sets, order_by='cardinality', limit=None, colors=None)[source]

generates the list of sets from a dict

Parameters
Return type

UpSetJSWidget

generate_distinct_intersections(min_degree=0, max_degree=None, empty=False, order_by='cardinality', limit=None, colors=None)[source]

customize the generation of the sets

Parameters
Return type

UpSetJSWidget

generate_intersections(min_degree=0, max_degree=None, empty=False, order_by='cardinality', limit=None, colors=None)[source]

customize the generation of the sets

Parameters
Return type

UpSetJSWidget

generate_unions(min_degree=0, max_degree=None, empty=False, order_by='cardinality', limit=None, colors=None)[source]

customize the generation of the sets

Parameters
Return type

UpSetJSWidget

height_ratios

An instance of a Python tuple.

hover_hint_color

A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’

not_member_color

A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’

numeric_scale

An enum whose value must be in a given sequence.

set_name

A trait for unicode strings.

set_name_axis_offset

A float trait.

width_ratios

An instance of a Python tuple.

model definitions for UpSet

class upsetjs_jupyter_widget._model.UpSetAttribute(attr_type, name, values, domain=None, categories=None, elems=None)[source]

helper structure for specifying font sizes

Parameters
attr_type: str = None
categories: t.Optional[t.List[t.Union[str, t.Dict]]] = None
domain: t.Optional[t.Tuple[float, float]] = None
elems: t.Optional[t.List[T]] = None
name: str = None
to_json()[source]

converts this instance to a regular dictionary for transfering

values: t.Union[t.List[str], t.List[float]] = None
class upsetjs_jupyter_widget._model.UpSetBaseSet(set_type, name, elems=None, color=None, cardinality=None)[source]

a set base class

Parameters
cardinality: int = None
color: t.Optional[str] = None
elems: t.FrozenSet[T] = None
name: str = None
set_type: UpSetSetType = None
class upsetjs_jupyter_widget._model.UpSetFontSizes(**kwargs)[source]

helper structure for specifying font sizes

axis_tick: Union[None, str, int] = None
bar_label: Union[None, str, int] = None
chart_label: Union[None, str, int] = None
copy()[source]

returns a copy / clone of this instance

description: Union[None, str, int] = None
export_label: Union[None, str, int] = None
legend: Union[None, str, int] = None
set_label: Union[None, str, int] = None
title: Union[None, str, int] = None
to_json()[source]

converts this instance to a regular dictionary for transfering

value_label: Union[None, str, int] = None
class upsetjs_jupyter_widget._model.UpSetQuery(name, color, upset=None, elems=None)[source]

a query representation in UpSet

Parameters
color: str = None
elems: t.Optional[t.FrozenSet[T]] = None
name: str = None
set: t.Optional[UpSetSetLike[T]] = None
class upsetjs_jupyter_widget._model.UpSetSet(name='', elems=None, color=None, cardinality=None)[source]

a set representation within UpSet

Parameters
cardinality = None
color = None
property degree

the degree of this set, i.e., the number of contained sets

elems = None
name = None
set_type = None
class upsetjs_jupyter_widget._model.UpSetSetCombination(set_type, name='', elems=None, sets=None, color=None, cardinality=None)[source]

a set combination within UpSet.js like an intersection

Parameters
property degree

the degree of this set, i.e., the number of contained sets

sets: t.FrozenSet[UpSetSet[T]] = None

the set of UpSetSets this set combination is composed of

class upsetjs_jupyter_widget._model.UpSetSetComposite(name='', elems=None, sets=None, color=None, cardinality=None)[source]

a set composite representation in UpSet

Parameters
sets = None
class upsetjs_jupyter_widget._model.UpSetSetDistinctIntersection(name='', elems=None, sets=None, color=None, cardinality=None)[source]

a distinct set intersection representation in UpSet

Parameters
sets = None
class upsetjs_jupyter_widget._model.UpSetSetIntersection(name='', elems=None, sets=None, color=None, cardinality=None)[source]

a set intersection representation in UpSet

Parameters
sets = None
class upsetjs_jupyter_widget._model.UpSetSetType[source]

enum of which type the set is

COMPOSITE = 'composite'
DISTINCT_INTERSECTION = 'distinctIntersection'
INTERSECTION = 'intersection'
SET = ('set',)
UNION = 'union'
class upsetjs_jupyter_widget._model.UpSetSetUnion(name='', elems=None, sets=None, color=None, cardinality=None)[source]

a set union representation in UpSet

Parameters
sets = None