Skip to main content

LinearHicDisplay

Note: this document is automatically generated from mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info

Also note: this document represents the state model API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag

Source code

GitHub page

Docs​

extends BaseLinearDisplay

LinearHicDisplay - Properties​

property: type​

// type signature
ISimpleType<"LinearHicDisplay">
// code
type: types.literal('LinearHicDisplay')

property: configuration​

// type signature
AnyConfigurationSchemaType
// code
configuration: ConfigurationReference(configSchema)

property: resolution​

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
resolution: types.optional(types.number, 1)

property: useLogScale​

// type signature
false
// code
useLogScale: false

property: colorScheme​

// type signature
IMaybe<ISimpleType<string>>
// code
colorScheme: types.maybe(types.string)

property: activeNormalization​

// type signature
string
// code
activeNormalization: 'KR'

property: mode​

// type signature
string
// code
mode: 'triangular'

LinearHicDisplay - Getters​

getter: blockType​

// type
string

getter: rendererTypeName​

// type
string

LinearHicDisplay - Methods​

method: renderProps​

// type signature
renderProps: () => any

method: trackMenuItems​

// type signature
trackMenuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuItem | RadioMenuItem | SubMenuItem | { ...; } | { ...; } | { ...; })[]

LinearHicDisplay - Actions​

action: setResolution​

// type signature
setResolution: (n: number) => void

action: setUseLogScale​

// type signature
setUseLogScale: (f: boolean) => void

action: setColorScheme​

// type signature
setColorScheme: (f?: string) => void

action: setActiveNormalization​

// type signature
setActiveNormalization: (f: string) => void

action: setAvailableNormalizations​

// type signature
setAvailableNormalizations: (f: string[]) => void

action: setMode​

// type signature
setMode: (arg: string) => void