Class StructureOptions

Hierarchy

OptionsGroup
- StructureOptions

Index

Constructors

Constructors

constructor

new StructureOptions(root, positionSettings, propertiesName?): StructureOptions
Parameters
- root: HTMLElement
- positionSettings: PositioningCallback
- propertiesName: string[] = []
Returns StructureOptions
Overrides OptionsGroup.constructor
- Defined in structure/options.ts:72

Properties

atomLabels

atomLabels: HTMLOption<"boolean">

atoms

atoms: HTMLOption<"boolean">

axes

axes: HTMLOption<"string">

bonds

bonds: HTMLOption<"boolean">

color

color: {
    max: HTMLOption<"number">;
    min: HTMLOption<"number">;
    palette: HTMLOption<"string">;
    property: HTMLOption<"string">;
    transform: HTMLOption<"string">;
}

Type declaration

max: HTMLOption<"number">
min: HTMLOption<"number">
palette: HTMLOption<"string">
property: HTMLOption<"string">
transform: HTMLOption<"string">

environments

environments: {
    activated: HTMLOption<"boolean">;
    bgColor: HTMLOption<"string">;
    bgStyle: HTMLOption<"string">;
    center: HTMLOption<"boolean">;
    cutoff: HTMLOption<"number">;
}

Type declaration

activated: HTMLOption<"boolean">
bgColor: HTMLOption<"string">
bgStyle: HTMLOption<"string">
center: HTMLOption<"boolean">
cutoff: HTMLOption<"number">

keepOrientation

keepOrientation: HTMLOption<"boolean">

playbackDelay

playbackDelay: HTMLOption<"number">

rotation

rotation: HTMLOption<"boolean">

shape

shape: HTMLOption<"string">

spaceFilling

spaceFilling: HTMLOption<"boolean">

supercell

supercell: [HTMLOption<"int">, HTMLOption<"int">, HTMLOption<"int">]

unitCell

unitCell: HTMLOption<"boolean">

Accessors

modal

get modal(): default
Get the modal used for these settings

Returns default
- Defined in structure/options.ts:170

Methods

applySettings

applySettings(settings): void
Applies saved settings, possibly filling in with default values
Parameters
- settings: Settings
Returns void
Overrides OptionsGroup.applySettings
- Defined in structure/options.ts:186

`Protected` foreachOption

foreachOption(callback): void
Call the given callback on each setting inside the given SettingGroup.

Keys starting with an underscore character are ignored.
Parameters
- callback: OptionsCallback
  callback operating on a single setting
Returns void
Inherited from OptionsGroup.foreachOption
- Defined in options.ts:413

getModalElement

getModalElement<T>(id): T
Get in a element in the modal from its id
Type Parameters
- T extends HTMLElement = HTMLElement
Parameters
- id: string
Returns T
- Defined in structure/options.ts:165

onSettingChange

onSettingChange(callback): void
Add the given callback to be called whenever a setting changes. The callback will be given the path to the settings as a list of keys; and the new value of the setting.

There is currently no way to remove a callback.
Parameters
- callback: ((keys, value) => void)
  - - (keys, value): void
    - Parameters
      keys: string[]
      value: unknown
      Returns void
Returns void
Inherited from OptionsGroup.onSettingChange
- Defined in options.ts:399

remove

remove(): void
Remove all HTML added by this StructureSettings in the current document

Returns void
- Defined in structure/options.ts:178

saveSettings

saveSettings(): Settings
Save the current values of all HTMLOption properties of the class, including nested ones.

Properties which name starts with an underscore are ignored.

Returns Settings
An object with the same structure as this class containing the values of all settings.
Inherited from OptionsGroup.saveSettings
- Defined in options.ts:327

Class StructureOptions

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StructureOptions

Properties

atomLabels

atoms

axes

bonds

color

Type declaration

max: HTMLOption<"number">

min: HTMLOption<"number">

palette: HTMLOption<"string">

property: HTMLOption<"string">

transform: HTMLOption<"string">

environments

Type declaration

activated: HTMLOption<"boolean">

bgColor: HTMLOption<"string">

bgStyle: HTMLOption<"string">

center: HTMLOption<"boolean">

cutoff: HTMLOption<"number">

keepOrientation

playbackDelay

rotation

shape

spaceFilling

supercell

unitCell

Accessors

modal

Returns default

Methods

applySettings

Parameters

Returns void

Protected foreachOption

Parameters

Returns void

getModalElement

Type Parameters

Parameters

Returns T

onSettingChange

Parameters

Parameters

Returns void

Returns void

remove

Returns void

saveSettings

Returns Settings

Settings

Member Visibility

Theme

On This Page

`Protected` foreachOption