frontend/lib/src/components/widgets/DataFrame/dimensionUtils.ts - develop - vshmidt/streamlit

frontend/lib/src/components/widgets/DataFrame/dimensionUtils.ts
114 строк3 KB
Lukas Masuch
Remove deprecated and unused proto messages and fields (#13760)
30 янв 2026, 19:48
30 янв 2026, 19:4885240a9
/**
 * Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { streamlit } from "@streamlit/protobuf"

/**
 * Helper function to determine if we should use container width based on the widthConfig.
 */
export function shouldUseContainerWidth(
  widthConfig?: streamlit.IWidthConfig | null
): boolean {
  return widthConfig?.useStretch ?? false
}

/**
 * Helper function to get the configured width from the widthConfig.
 */
export function getConfiguredWidth(
  widthConfig?: streamlit.IWidthConfig | null
): number | undefined {
  if (widthConfig?.pixelWidth) {
    return widthConfig.pixelWidth
  }
  return undefined
}

/**
 * Helper function to determine if the element is configured to use content width.
 */
export function shouldUseContentWidth(
  widthConfig?: streamlit.IWidthConfig | null
): boolean {
  return widthConfig?.useContent ?? false
}

/**
 * Helper function to determine if the element is configured to use stretch height.
 * Stretch height is not enabled when the element is in the root container. Without a
 * fixed height enclosing container, there is nothing to stretch and the dataframe ends
 * up collapsed to minimum height to so we use auto height mode instead.
 */
export function shouldUseStretchHeight(
  heightConfig?: streamlit.IHeightConfig | null,
  isInRoot?: boolean
): boolean {
  if (isInRoot) {
    return false
  }
  return heightConfig?.useStretch ?? false
}

/**
 * Helper function to determine if the element is configured to use content height.
 */
export function shouldUseContentHeight(
  heightConfig?: streamlit.IHeightConfig | null
): boolean {
  return heightConfig?.useContent ?? false
}

/**
 * Helper function to get the configured height from the heightConfig.
 */
export function getConfiguredHeight(
  heightConfig?: streamlit.IHeightConfig | null
): number | undefined {
  if (heightConfig?.pixelHeight) {
    return heightConfig.pixelHeight
  }
  return undefined
}

/**
 * Calculate the total height of a table based on the number of rows and styling.
 *
 * @param numRows - Number of data rows
 * @param rowHeight - Height of each row in pixels
 * @param theme - Grid theme containing header height and border width
 * @param numHeaderRows - Number of header rows (1 for normal, 2 for grouped)
 * @returns Total calculated height in pixels
 */
export function calculateTableHeight({
  numRows,
  rowHeight,
  theme,
  numHeaderRows = 1,
}: {
  numRows: number
  rowHeight: number
  theme: {
    defaultHeaderHeight: number
    tableBorderWidth: number
  }
  numHeaderRows?: number
}): number {
  return (
    numRows * rowHeight +
    numHeaderRows * theme.defaultHeaderHeight +
    2 * theme.tableBorderWidth
  )
}