Skip to main content

DotplotDisplay

Note: this document is automatically generated from @jbrowse/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​

DotplotDisplay - Properties​

property: type​

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

property: configuration​

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

property: colorBy​

color by setting that overrides the config setting

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
colorBy: types.optional(types.string, 'default')

DotplotDisplay - Getters​

getter: rendererTypeName​

// type
any

DotplotDisplay - Methods​

method: renderProps​

// type signature
renderProps: () => any

method: renderSvg​

// type signature
renderSvg: (opts: ExportSvgOptions & { theme?: ThemeOptions; }) => Promise<Element>

DotplotDisplay - Actions​

action: setLoading​

// type signature
setLoading: (stopToken?: string) => void

action: setMessage​

// type signature
setMessage: (messageText: string) => void

action: setRendered​

// type signature
setRendered: (args?: { data: any; reactElement: ReactElement<unknown, string | JSXElementConstructor<any>>; renderingComponent: Component<{}, {}, any>; }) => void

action: setError​

// type signature
setError: (error: unknown) => void

action: setAlpha​

// type signature
setAlpha: (value: number) => void

action: setMinAlignmentLength​

// type signature
setMinAlignmentLength: (value: number) => void

action: setColorBy​

// type signature
setColorBy: (value: string) => void