Winter Cardinal UI - v0.442.0 / DApplicationLayerOptions
DApplicationLayer options
• new DApplicationLayerOptions(options): DApplicationLayerOptions
| Name | Type |
|---|---|
options |
DApplicationLayerOptionsOptions |
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:52
▸ getAntialias(): boolean
Returns an antialias setting. The default antialias setting is false.
boolean
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:267
▸ getBackgroundColor(): number
Returns a background color.
number
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:249
▸ getHeight(): number
Returns a canvas height.
number
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:188
▸ getPadding(): DPadding
Returns padding sizes. The default padding size is 6.
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:225
▸ getPixiApplicationOptions(): PixiApplicationOptions
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:288
▸ getRootElement(): HTMLElement
Returns a root element.
HTMLCanvasElement and other DOM elements are created in this element.
The default root element is document.body.
HTMLElement
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:125
▸ getWidth(): number
Returns a canvas width.
number
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:152
▸ isHeightFixed(): boolean
Returns true if the height is fixed.
boolean
true if the height is fixed.
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:207
▸ isOverlay(): boolean
Returns true if a layer is supposed to be an overlay layer.
boolean
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:284
▸ isWidthFixed(): boolean
Returns true if the width is fixed.
boolean
true if the width is fixed.
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:171
▸ setAntialias(antialias): this
Sets an antialias setting.
| Name | Type | Description |
|---|---|---|
antialias |
boolean |
new antialias setting |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:276
▸ setBackgroundColor(color): this
Sets a background color.
| Name | Type | Description |
|---|---|---|
color |
number |
new background color |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:258
▸ setHeight(height): this
Sets a canvas height.
| Name | Type | Description |
|---|---|---|
height |
number |
new canvas height |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:197
▸ setHeightFixed(fixed): this
Makes the canvas height fixed.
| Name | Type | Description |
|---|---|---|
fixed |
boolean |
true to make the canvas height fixed |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:216
▸ setPadding(left, top, right, bottom): this
Sets padding sizes.
| Name | Type | Description |
|---|---|---|
left |
number |
new left padding |
top |
number |
new top padding |
right |
number |
new right padding |
bottom |
number |
new bottom padding |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:237
▸ setRootElement(root, updateWidthAndHeight?): this
Sets a root element and updates the canvas width and height
if updateWidthAndHeight is not false.
| Name | Type | Description |
|---|---|---|
root |
HTMLElement |
new root element |
updateWidthAndHeight? |
boolean |
false to preserve the canvas width / height |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:136
▸ setWidth(width): this
Sets a canvas width.
| Name | Type | Description |
|---|---|---|
width |
number |
new canvas width |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:161
▸ setWidthFixed(fixed): this
Makes the canvas width fixed.
| Name | Type | Description |
|---|---|---|
fixed |
boolean |
true to make the canvas width fixed |
this
src/main/typescript/wcardinal/ui/d-application-layer-options.ts:180