xb.Gap

class excelbird.Gap(value=None, *args, **kwargs)

A spacer inside a container. The parent container will decide what to do with the Gap, and convert it into the appropriate type.

Parameters:

valueint, default 1

The gap distance, measured in cells

**kwargs

Additional keyword arguments are passed to the resulting type when the parent container creates it. This lets you apply styling to the gap

Attributes:

fill_val

Methods

ref([inherit_style])

Get a copy.

Gap Methods

excelbird.Gap.ref(self, inherit_style: bool = False, **kwargs) → Gap

Get a copy.

Gap has this method because parent containers will call .ref() on each of their children, passing the same set of arguments. It’s unlikely you’ll ever want to call this method on a Gap directly.

Parameters:

inherit_stylebool, default False

Copy the caller’s style to the returned object.

**kwargsAny

Extra keyword arguments are set as attributes on the returned object.

Returns:

Gap