Interface SessionShading

What attachSessionShading returns: the shade's controls, and its removal.

interface SessionShading {
    destroy(): void;
    options(): SessionShadeOptions;
    setOptions(patch: SessionShadeOptions): void;
}

Index

Methods

destroy options setOptions

Methods

destroy

destroy(): void
Take the shade off the chart. Calling it again does nothing.

Returns void
- Defined in src/primitives/session-shade.ts:49

options

options(): SessionShadeOptions
The options in force.

Returns SessionShadeOptions
- Defined in src/primitives/session-shade.ts:47

setOptions

setOptions(patch: SessionShadeOptions): void
Change some options; the rest keep their values.
Parameters
- patch: SessionShadeOptions
Returns void
- Defined in src/primitives/session-shade.ts:45