Files
blockly/core/renderers/measurables/icon.ts
Maribeth Bottorff 037eb59b89 chore: Lint TsDoc. (#6353)
* chore: add linting for tsdoc

* chore: don't require types on return

* chore: remove redundant fileoverview from ts

* chore: change return to returns and add some newlines

* chore: remove license tag

* chore: don't require params/return docs

* chore: remove spurious struct tags

* Revert "chore: change return to returns and add some newlines"

This reverts commit d6d8656a45.

* chore: don't auto-add param names

* chore: disable require-param bc it breaks on this

* return to returns and add line breaks

* chore: configure additional jsdoc rules

* chore: run format

* Revert "chore: remove license tag"

This reverts commit 173455588a.

* chore: allow license tag format

* chore: only require jsdoc on exported items

* chore: add missing jsdoc or silence where needed

* chore: run format

* chore: lint fixes
2022-08-23 14:27:22 -07:00

52 lines
1.2 KiB
TypeScript

/**
* @license
* Copyright 2019 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* Objects representing an icon in a row of a rendered
* block.
*
* @class
*/
import * as goog from '../../../closure/goog/goog.js';
goog.declareModuleId('Blockly.blockRendering.Icon');
/* eslint-disable-next-line no-unused-vars */
import type {Icon as BlocklyIcon} from '../../icon.js';
import type {ConstantProvider} from '../common/constants.js';
import {Measurable} from './base.js';
import {Types} from './types.js';
/**
* An object containing information about the space an icon takes up during
* rendering
*
* @alias Blockly.blockRendering.Icon
*/
export class Icon extends Measurable {
isVisible: boolean;
/**
* An object containing information about the space an icon takes up during
* rendering
*
* @param constants The rendering constants provider.
* @param icon The icon to measure and store information for.
* @internal
*/
constructor(constants: ConstantProvider, public icon: BlocklyIcon) {
super(constants);
this.isVisible = icon.isVisible();
this.type |= Types.ICON;
const size = icon.getCorrectedSize();
this.height = size.height;
this.width = size.width;
}
}