Interface RenderOptions

Interface defining global rendering options for a Fabric.js canvas. RenderOptions

Description

Configures rendering parameters for a Fabric.js canvas, used in BasicCanvasRenderer. All width and height values are in pixels (px).

See

BasicCanvasRenderer - Class utilizing these options.

interface RenderOptions {
    canvasHeight?: number;
    canvasWidth?: number;
    canvasWrapperStroke?: boolean;
    colorScheme?: ColorSchemeEnum;
    contentLabelLeftWidth?: number;
    contentLabelRightWidth?: number;
    contentLabelWidth?: number;
    contentScoringWidth?: number;
    contentWidth?: number;
    currentColor?: string;
    currentDisabled?: boolean;
    currentDomainDatabase?: string;
    fontFamily?: string;
    fontSize?: number;
    fontWeigth?: string;
    jobId?: string;
    logSkippedHsps?: boolean;
    marginWidth?: number;
    numberHits?: number;
    numberHsps?: number;
    scaleLabelWidth?: number;
    scaleType?: ScaleTypeEnum;
    scaleWidth?: number;
    scoreType?: ScoreTypeEnum;
    staticCanvas?: boolean;
    strokeDashArray?: [number, number];
    strokeWidth?: number;
}

Properties

canvasHeight? canvasWidth? canvasWrapperStroke? colorScheme? contentLabelLeftWidth? contentLabelRightWidth? contentLabelWidth? contentScoringWidth? contentWidth? currentColor? currentDisabled? currentDomainDatabase? fontFamily? fontSize? fontWeigth? jobId? logSkippedHsps? marginWidth? numberHits? numberHsps? scaleLabelWidth? scaleType? scaleWidth? scoreType? staticCanvas? strokeDashArray? strokeWidth?

Properties

OptionalcanvasHeight

canvasHeight?: number

Canvas height in pixels.

OptionalcanvasWidth

canvasWidth?: number

Canvas width in pixels.

OptionalcanvasWrapperStroke

canvasWrapperStroke?: boolean

Whether to stroke the canvas wrapper.

OptionalcolorScheme

colorScheme?: ColorSchemeEnum

Color scheme for rendering.

OptionalcontentLabelLeftWidth

contentLabelLeftWidth?: number

Width for left-side sequence/domain info.

OptionalcontentLabelRightWidth

contentLabelRightWidth?: number

Width for right-side sequence/domain info.

OptionalcontentLabelWidth

contentLabelWidth?: number

Width for sequence information.

OptionalcontentScoringWidth

contentScoringWidth?: number

Width for scoring information.

OptionalcontentWidth

contentWidth?: number

Width of the visualization content.

OptionalcurrentColor

currentColor?: string

Current color value.

OptionalcurrentDisabled

currentDisabled?: boolean

Whether rendering is disabled.

OptionalcurrentDomainDatabase

currentDomainDatabase?: string

Current domain database name.

OptionalfontFamily

fontFamily?: string

Font family.

OptionalfontSize

fontSize?: number

Font size in pixels.

OptionalfontWeigth

fontWeigth?: string

Font weight (likely a typo, should be fontWeight).

OptionaljobId

jobId?: string

Job identifier for the data.

OptionallogSkippedHsps

logSkippedHsps?: boolean

Whether to log skipped HSPs.

OptionalmarginWidth

marginWidth?: number

Margin space around objects.

OptionalnumberHits

numberHits?: number

Number of hits to display.

OptionalnumberHsps

numberHsps?: number

Number of HSPs to display.

OptionalscaleLabelWidth

scaleLabelWidth?: number

Width for color score information.

OptionalscaleType

scaleType?: ScaleTypeEnum

Scale type for visualization.

OptionalscaleWidth

scaleWidth?: number

Width of the color scale.

OptionalscoreType

scoreType?: ScoreTypeEnum

Score type for visualization.

OptionalstaticCanvas

staticCanvas?: boolean

Whether to use a static canvas (no interactivity).

OptionalstrokeDashArray

strokeDashArray?: [number, number]

Dash array for strokes.

OptionalstrokeWidth

strokeWidth?: number

Stroke width in pixels.

Settings

Member Visibility

On This Page

Properties